feat(ws): Implement pause workspace functionality as backend API #328

andyatmiami · 2025-05-12T19:04:45Z

related: #298

Added PauseWorkspaceHandler to handle the pause operation for workspaces.
Introduced new route for pausing workspaces in the API.
- POST api/v1/workspaces/{namespace}/{workspaceName}/actions/pause
Created a new EmptyResponse type for successful responses.
Added tests for the pause workspace functionality, including success and error cases.
Updated OpenAPI/README documentation to include the new pause workspace endpoint.

Functionality was tested via the Swagger client:

$ kubectl get workspaces -A
NAMESPACE   NAME                           STATE
default     andy-test-direct-with-secret   Running
default     andy-test-pr-verify            Running
default     andy-test-with-secret          Running
default     andy-test-with-secret-no-op    Running
default     jupyterlab-workspace           Paused

<executed /pause via Swagger client>

$ kubectl get workspaces -A
NAMESPACE   NAME                           STATE
default     andy-test-direct-with-secret   Running
default     andy-test-pr-verify            Paused
default     andy-test-with-secret          Running
default     andy-test-with-secret-no-op    Running
default     jupyterlab-workspace           Paused

$ kubectl get events --sort-by='.lastTimestamp'
LAST SEEN   TYPE      REASON                             OBJECT                                     MESSAGE
...
89s         Normal    Killing                            pod/ws-andy-test-pr-verify-z5qfg-0         Stopping container main
89s         Normal    SuccessfulDelete                   statefulset/ws-andy-test-pr-verify-z5qfg   delete Pod ws-andy-test-pr-verify-z5qfg-0 in StatefulSet ws-andy-test-pr-verify-z5qfg successful

google-oss-prow · 2025-05-12T19:04:52Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign kimwnasptd for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

related: kubeflow#298 - Added PauseWorkspaceHandler to handle the pause operation for workspaces. - Introduced new route for pausing workspaces in the API. - Created a new EmptyResponse type for successful responses. - Added tests for the pause workspace functionality, including success and error cases. - Updated README/OpenAPI documentation to include the new pause workspace endpoint. Signed-off-by: Andy Stoneberg <[email protected]>

harshad16

well designed
lgtm

small nitpick question, was wondering about the request resposne being empty.
as after the pause action , one has to do get on /workspaces/{namespace}/{workspace_name}

Tested:

Cli:

swagger:

harshad16 · 2025-05-20T19:56:07Z

workspaces/backend/openapi/swagger.json

+                        "description": "Successful action. Returns an empty JSON object.",
+                        "schema": {
+                            "$ref": "#/definitions/api.EmptyResponse"


Suggested change

"description": "Successful action. Returns an empty JSON object.",

"schema": {

"$ref": "#/definitions/api.EmptyResponse"

"description": "Successful action. Returns the paused workspace object.",

"schema": {

"$ref": "#/definitions/api.WorkspaceEnvelope"

The backend should return the object or the status of the workspace object or custom info that is agreed, so frontend can update the label or module based on this response.
WDYT ? is it for the first iteration, we wanna keep it empty till we discuss the format ?

harshad16 · 2025-05-20T20:11:09Z

workspaces/backend/README.md

+| PATCH /api/v1/workspaces/{namespace}/{name}               | TBD                       | Patch a Workspace entity                |
+| PUT /api/v1/workspaces/{namespace}/{name}                 | TBD                       | Update a Workspace entity               |
+| DELETE /api/v1/workspaces/{namespace}/{name}              | workspaces_handler        | Delete a Workspace entity               |
+| POST /api/v1/workspaces/{namespace}/{name}/actions/pause  | workspace_actions_handler | Pause a running workspace             |


nitpick: Seems like the table format is missing here.
can be neglected for next time

harshad16 · 2025-05-20T20:15:38Z

workspaces/backend/api/workspace_actions_handler.go

+		return
+	}
+
+	// Return 200 OK with empty JSON object


instead of returning a empty, shall we return the workspace object , so frontend can use this information ?

very valid feedback and happy to implement as such if folks agree that is preferred.

my rationale for structuring this as such (with an "empty object") was:

this endpoint is really focused and designed to only set the spec.paused attribute - and as such - there is nothing to be returned that the client wouldn't already know if they cared to (or already has rendered in the case of our frontend)... returning the entirety of the workspace implies the client should update/merge that with this existing state - and I didn't feel it necessary/warranted (purely my $0.02!)

if client receives 200 response - they can infer the value of spec.paused to be updated in their state without having to parse a payload

as this endpoint lives under this /actions "umbrella" - I didn't necessarily want to enforce the Envelope structure when other endpoints that live under /actions (like say, logs or something?) would themselves have totally different structures - such that trying to be consistent within /actions is probably impossible moving forward

Given those 2 points above - I leaned towards {}

But again, it was something I myself wondered during implementation - and willing to change if we get another +1 that the Envelope response would be preferred!

ack, thanks for the explanation behind the return type,
if frontend has the state, and can set the paused based on information, we should be good.

i guess, i need to fimilarize myself with frontend a little bit, how the state of the paused/start are being displayed.

Andy, for consistency and forward compatibility, returning an envelope object is preferred even for action endpoints like pause.

It will make it much easier on FE if the backend always returns an envelope (plus the right status code) and never an empty response.

This will help, for instance, in case of an error, and avoid a bunch of if and else statements on the FE.
The structure should be like this:

{
"data": {
"status": "paused",
"message": "Workspace successfully paused."
}
}

type PauseResponse struct {
Status string json:"status" // e.g., "paused"
Message string json:"message" // optional
}

If we standardize on envelope makes us easy to evolve etc.

harshad16

/lgtm

google-oss-prow · 2025-05-20T21:44:25Z

@harshad16: changing LGTM is restricted to collaborators

In response to this:

/lgtm

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

ederign

for consistency and forward compatibility, returning an envelope object is preferred even for all backend endpoints

ederign · 2025-05-21T11:31:23Z

workspaces/backend/api/workspace_actions_handler.go

+		return
+	}
+
+	// Return 200 OK with empty JSON object


Andy, for consistency and forward compatibility, returning an envelope object is preferred even for action endpoints like pause.

It will make it much easier on FE if the backend always returns an envelope (plus the right status code) and never an empty response.

This will help, for instance, in case of an error, and avoid a bunch of if and else statements on the FE.
The structure should be like this:

{
"data": {
"status": "paused",
"message": "Workspace successfully paused."
}
}

type PauseResponse struct {
Status string json:"status" // e.g., "paused"
Message string json:"message" // optional
}

If we standardize on envelope makes us easy to evolve etc.

andyatmiami · 2025-05-21T15:52:14Z

closing this PR in favor of #340 - but will apply all PR review comments as I update and squash those commits!

github-project-automation bot added this to Kubeflow Notebooks May 12, 2025

github-project-automation bot moved this to Needs Triage in Kubeflow Notebooks May 12, 2025

google-oss-prow bot requested review from kimwnasptd and thesuperzapper May 12, 2025 19:04

google-oss-prow bot added the size/XL label May 12, 2025

andyatmiami mentioned this pull request May 14, 2025

feat(ws): Implement workspace start + pause as backend APIs #340

Open

andyatmiami force-pushed the feat/workspace-pause-api branch from 752e138 to 0882a6b Compare May 14, 2025 20:10

andyatmiami force-pushed the feat/workspace-pause-api branch from 0882a6b to 1d39e52 Compare May 15, 2025 19:41

harshad16 reviewed May 20, 2025

View reviewed changes

harshad16 approved these changes May 20, 2025

View reviewed changes

ederign suggested changes May 21, 2025

View reviewed changes

google-oss-prow bot assigned ederign May 21, 2025

andyatmiami closed this May 21, 2025

github-project-automation bot moved this from Needs Triage to Done in Kubeflow Notebooks May 21, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(ws): Implement pause workspace functionality as backend API #328

feat(ws): Implement pause workspace functionality as backend API #328

Uh oh!

andyatmiami commented May 12, 2025 •

edited

Loading

Uh oh!

google-oss-prow bot commented May 12, 2025

Uh oh!

harshad16 left a comment •

edited

Loading

Uh oh!

harshad16 May 20, 2025 •

edited

Loading

Uh oh!

harshad16 May 20, 2025

Uh oh!

harshad16 May 20, 2025

Uh oh!

andyatmiami May 20, 2025

Uh oh!

harshad16 May 20, 2025

Uh oh!

ederign May 21, 2025

Uh oh!

harshad16 left a comment

Uh oh!

google-oss-prow bot commented May 20, 2025

Uh oh!

ederign left a comment

Uh oh!

ederign May 21, 2025

Uh oh!

andyatmiami commented May 21, 2025

Uh oh!

Uh oh!

feat(ws): Implement pause workspace functionality as backend API #328

feat(ws): Implement pause workspace functionality as backend API #328

Uh oh!

Conversation

andyatmiami commented May 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

google-oss-prow bot commented May 12, 2025

Uh oh!

harshad16 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

harshad16 May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

harshad16 May 20, 2025

Choose a reason for hiding this comment

Uh oh!

harshad16 May 20, 2025

Choose a reason for hiding this comment

Uh oh!

andyatmiami May 20, 2025

Choose a reason for hiding this comment

Uh oh!

harshad16 May 20, 2025

Choose a reason for hiding this comment

Uh oh!

ederign May 21, 2025

Choose a reason for hiding this comment

Uh oh!

harshad16 left a comment

Choose a reason for hiding this comment

Uh oh!

google-oss-prow bot commented May 20, 2025

Uh oh!

ederign left a comment

Choose a reason for hiding this comment

Uh oh!

ederign May 21, 2025

Choose a reason for hiding this comment

Uh oh!

andyatmiami commented May 21, 2025

Uh oh!

Uh oh!

andyatmiami commented May 12, 2025 •

edited

Loading

harshad16 left a comment •

edited

Loading

harshad16 May 20, 2025 •

edited

Loading