Add maximum lifetime constraint for a workspace #8307

princerachit · 2022-02-18T11:38:59Z

Description

Add maximum lifetime constraint for a workspace. Timeout the workspace if it breaches the limit. The default value is 36 hours or 2160m

Related Issue(s)

Fixes #7318

How to test

Edit ws-manager configmap and update the maxLifetime value to something short e.g. 3m00s
Restart ws-manager
Start a new workspace
Make some changes in the workspace
The workspace should timeout automatically after 3 mins even when there was a recent activity
Check the status of the ws in the db. It should correctly show the reason of timeout:

status: {"repo": {"branch": "master", "latestCommit": "e81cb46b130e72e96096a91523ed76d00d3263d5", "uncommitedFiles": ["README.md"], "totalUntrackedFiles": 0, "totalUncommitedFiles": 1, "totalUnpushedCommits": 0}, "phase": "stopped", "nodeIp": "10.132.0.41", "message": "", "podName": "ws-10d2368f-69ea-4b10-a7a7-7c6e59c37d6c", "timeout": "60m", "nodeName": "gke-core-dev-workspace-4-adb83b08-505z", "conditions": {"failed": "", "timeout": "workspace timed out after maximum lifetime (00h03m) took longer than 00h03m", "deployed": false, "pullingImages": false, "stoppedByRequest": false, "headlessTaskFailed": ""}, "ownerToken": "RYhpErXpCr6U2MJvkFpUSxWp6ZmqGAXO", "exposedPorts": []}

Start the workspace again from thew dashboard
Verify that the changes persisted

Release Notes

Add max lifetime timeout for a workspace

Documentation

codecov · 2022-02-18T14:02:16Z

Codecov Report

Merging #8307 (58dc389) into main (26e2777) will decrease coverage by 2.94%.
The diff coverage is 80.00%.

@@            Coverage Diff             @@
##             main    #8307      +/-   ##
==========================================
- Coverage   31.10%   28.15%   -2.95%     
==========================================
  Files          39       44       +5     
  Lines        5913     5689     -224     
==========================================
- Hits         1839     1602     -237     
- Misses       3934     3970      +36     
+ Partials      140      117      -23

Flag	Coverage Δ
components-gitpod-cli-app	`11.17% <ø> (ø)`
components-installer-raw-app	`5.62% <0.00%> (?)`
components-local-app-app-darwin-amd64	`?`
components-local-app-app-darwin-arm64	`?`
components-local-app-app-linux-amd64	`?`
components-local-app-app-linux-arm64	`?`
components-local-app-app-windows-386	`?`
components-local-app-app-windows-amd64	`?`
components-local-app-app-windows-arm64	`?`
components-supervisor-app	`?`
components-ws-manager-app	`40.63% <100.00%> (?)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
...s/installer/pkg/components/ws-manager/configmap.go	`29.88% <0.00%> (ø)`
components/ws-manager/pkg/manager/monitor.go	`9.46% <ø> (ø)`
components/ws-manager/pkg/manager/status.go	`75.13% <100.00%> (ø)`
components/local-app/pkg/auth/pkce.go
components/supervisor/pkg/supervisor/user.go
components/supervisor/pkg/ports/served-ports.go
components/supervisor/pkg/terminal/terminal.go
components/supervisor/pkg/terminal/ring-buffer.go
components/supervisor/pkg/ports/tunnel.go
components/supervisor/pkg/ports/ports.go
... and 40 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 26e2777...58dc389. Read the comment docs.

sagor999 · 2022-02-18T22:10:20Z

/hold

sagor999

changes look good to me, but added hold so that @csweichel can weigh in as well.

as far as UX goes, when workspace will timeout, do we show to user the reason for this anywhere? Or is it just will show up as stopped? as it might be confusing for those few who have workspaces running longer than 36 hours.
(if we don't have anything right now, @princerachit can you create a new issue for webapp team?)

princerachit · 2022-02-19T04:08:59Z

@sagor999 The reason for workspace timeout is not displayed. We can have this information but impact wise I am not so sure if it will be useful given that very few users actually run workspace for 36 hours.
I will create an issue for this.

csweichel

Other than a bunch of nits, this looks spot on.

Re showing feedback when a workspace times out: we currently show that the workspace timed out, but not why it did that: https://github.com/gitpod-io/gitpod/blob/main/components/dashboard/src/start/StartWorkspace.tsx#L526-L527

csweichel · 2022-02-21T08:49:24Z

chart/templates/ws-manager-configmap.yaml

@@ -82,6 +82,7 @@ data:
                "headlessWorkspace": "60m",
                "initialization": "30m",
                "regularWorkspace": "30m",
+                "maxLifetime": "2160m",


Suggested change

"maxLifetime": "2160m",

"maxLifetime": "36h",

csweichel · 2022-02-21T08:49:44Z

components/ws-manager/example-config.json

@@ -41,6 +41,7 @@
      "headlessWorkspace": "60m",
      "initialization": "30m",
      "regularWorkspace": "30m",
+      "maxLifetime": "2160m",


Suggested change

"maxLifetime": "2160m",

"maxLifetime": "36h",

csweichel · 2022-02-21T08:49:53Z

components/ws-manager/pkg/manager/integration_test.go

@@ -87,6 +87,7 @@ func forIntegrationTestGetManager(t *testing.T) *Manager {
 			Initialization:      util.Duration(30 * time.Minute),
 			TotalStartup:        util.Duration(45 * time.Minute),
 			RegularWorkspace:    util.Duration(60 * time.Minute),
+			MaxLifetime:         util.Duration(2160 * time.Minute),


Suggested change

MaxLifetime: util.Duration(2160 * time.Minute),

MaxLifetime: util.Duration(36 * time.Hour),

csweichel · 2022-02-21T08:51:12Z

components/ws-manager/pkg/manager/status.go

+		timeout := m.Config.Timeouts.MaxLifetime
+		activity := activityMaxLifetime
+		if msg, err := decide(start, timeout, activity); msg != "" {
+			return msg, err
+		}


nit: can be simplified (we don't need the variable assignment here because there's no variance in the decision)

Suggested change

timeout := m.Config.Timeouts.MaxLifetime

activity := activityMaxLifetime

if msg, err := decide(start, timeout, activity); msg != "" {

return msg, err

}

if msg, err := decide(start, m.Config.Timeouts.MaxLifetime, activityMaxLifetime); msg != "" {

return msg, err

}

csweichel · 2022-02-21T08:51:33Z

components/ws-manager/pkg/manager/testing_test.go

@@ -56,6 +56,7 @@ func forTestingOnlyManagerConfig() config.Configuration {
 			Initialization:      util.Duration(30 * time.Minute),
 			TotalStartup:        util.Duration(45 * time.Minute),
 			RegularWorkspace:    util.Duration(60 * time.Minute),
+			MaxLifetime:         util.Duration(2160 * time.Minute),


Suggested change

MaxLifetime: util.Duration(2160 * time.Minute),

MaxLifetime: util.Duration(36 * time.Hour),

csweichel

LGTM

princerachit · 2022-02-22T10:53:08Z

/un-hold

princerachit · 2022-02-22T10:54:06Z

/unhold

roboquat added do-not-merge/work-in-progress do-not-merge/release-note-label-needed size/S labels Feb 18, 2022

princerachit force-pushed the princerachit/workspace-instances-7318 branch 2 times, most recently from 7e0d329 to a33db32 Compare February 18, 2022 12:13

roboquat added size/M and removed size/S labels Feb 18, 2022

princerachit force-pushed the princerachit/workspace-instances-7318 branch from a33db32 to 3edc6f6 Compare February 18, 2022 13:52

roboquat added size/XL release-note and removed size/M do-not-merge/release-note-label-needed labels Feb 18, 2022

princerachit marked this pull request as ready for review February 18, 2022 15:21

princerachit requested a review from a team February 18, 2022 15:21

princerachit requested review from csweichel and aledbf as code owners February 18, 2022 15:21

roboquat removed the do-not-merge/work-in-progress label Feb 18, 2022

github-actions bot added the team: workspace Issue belongs to the Workspace team label Feb 18, 2022

roboquat added the do-not-merge/hold label Feb 18, 2022

sagor999 previously approved these changes Feb 18, 2022

View reviewed changes

csweichel reviewed Feb 21, 2022

View reviewed changes

Add maximum lifetime constraint for a workspace

58dc389

princerachit dismissed sagor999’s stale review via 58dc389 February 21, 2022 10:28

princerachit force-pushed the princerachit/workspace-instances-7318 branch from 3edc6f6 to 58dc389 Compare February 21, 2022 10:28

princerachit requested a review from csweichel February 21, 2022 12:49

csweichel approved these changes Feb 21, 2022

View reviewed changes

roboquat removed the do-not-merge/hold label Feb 22, 2022

roboquat merged commit 4d48ccb into main Feb 22, 2022

roboquat deleted the princerachit/workspace-instances-7318 branch February 22, 2022 10:55

roboquat added deployed: workspace Workspace team change is running in production deployed Change is completely running in production labels Feb 24, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add maximum lifetime constraint for a workspace #8307

Add maximum lifetime constraint for a workspace #8307

princerachit commented Feb 18, 2022 •

edited

Loading

codecov bot commented Feb 18, 2022 •

edited

Loading

sagor999 commented Feb 18, 2022

sagor999 left a comment

princerachit commented Feb 19, 2022

csweichel left a comment

csweichel Feb 21, 2022

csweichel Feb 21, 2022

csweichel Feb 21, 2022

csweichel Feb 21, 2022

csweichel Feb 21, 2022

csweichel left a comment

princerachit commented Feb 22, 2022

princerachit commented Feb 22, 2022

	MaxLifetime: util.Duration(2160 * time.Minute),
	MaxLifetime: util.Duration(36 * time.Hour),

Add maximum lifetime constraint for a workspace #8307

Add maximum lifetime constraint for a workspace #8307

Conversation

princerachit commented Feb 18, 2022 • edited Loading

Description

Related Issue(s)

How to test

Release Notes

Documentation

codecov bot commented Feb 18, 2022 • edited Loading

Codecov Report

sagor999 commented Feb 18, 2022

sagor999 left a comment

Choose a reason for hiding this comment

princerachit commented Feb 19, 2022

csweichel left a comment

Choose a reason for hiding this comment

csweichel Feb 21, 2022

Choose a reason for hiding this comment

csweichel Feb 21, 2022

Choose a reason for hiding this comment

csweichel Feb 21, 2022

Choose a reason for hiding this comment

csweichel Feb 21, 2022

Choose a reason for hiding this comment

csweichel Feb 21, 2022

Choose a reason for hiding this comment

csweichel left a comment

Choose a reason for hiding this comment

princerachit commented Feb 22, 2022

princerachit commented Feb 22, 2022

princerachit commented Feb 18, 2022 •

edited

Loading

codecov bot commented Feb 18, 2022 •

edited

Loading