Set workspace class based on user preference #11313

Furisto · 2022-07-12T12:10:10Z

Description

This PR allows user to select their preferred workspace class and start a workspace with it. The feature is hidden behind a feature flag which is segmented to only activate the feature for members of gitpod. This means that WebApp can deploy this feature without having to wait for team workspace to configure the new workspace classes in the workspace clusters.

Currently there are 4 workspace classes that are supported:

default
gitpod-internal-xl
g1-standard
g1-large

Default and gitpod-internal-xl are the old internal workspace classes that will be eventually removed from the code. G1 are the new general purpose workspace classes that we are introducing.

Related Issue(s)

Fixes ##10843

How to test

Go to the dashboard and select your preferred workspace class in the settings
Open a workspace
You can check that you have the correct workspace class either by checking the labels on the pod (gitpod.io/workspaceClass) or checking the GITPOD_WORKSPACE_CLASS environment variable in the workspace. The available classes are g1-standard and g1-large.
Stop the workspace, then change your workspace class selection. Start the workspace again and check that the workspace still has the previously selected workspace class (the workspace class on a workspace needs to stay the same as otherwise downgrading to a lower workspace class could mean that content init will fail due to storage size limit).
Start a new workspace. The workspace should have new workspace class that you have configured.
Turn off the feature flag, then start a workspace. The workspace class configuration in the settings menu should be gone and the workspace should have the "default" workspace class instead of one of the new workspace classes. There should be no entry in the workspaceClass column of the workspace and workspace instance.
Stop the workspace, then turn on the feature flag again. Now start the workspace you just stopped. This tests if a workspace that has been created before workspace classes still starts correctly. The workspace will get assigned a class based on if the user "has more resources". That means either g1-standard will be assigned or g1-large.

Release Notes

None

Werft options:

/werft with-preview

Furisto · 2022-07-13T11:46:34Z

/werft run

👍 started the job as gitpod-build-fo-use-classes.11
(with .werft/ from main)

Furisto · 2022-07-13T11:58:37Z

/werft run with-preview with-clean-slate-deployment

👍 started the job as gitpod-build-fo-use-classes.12
(with .werft/ from main)

components/server/src/workspace/workspace-starter.ts

components/gitpod-db/src/typeorm/entity/db-workspace.ts

install/installer/pkg/components/server/configmap.go

Furisto · 2022-07-15T17:25:41Z

@geropl PTAL

components/server/src/config.ts

components/server/src/workspace/workspace-starter.ts

geropl · 2022-07-19T07:49:28Z

install/installer/pkg/components/server/configmap.go

@@ -237,6 +237,22 @@ func configmap(ctx *common.RenderContext) ([]runtime.Object, error) {
 			// default limit for all cloneURLs
 			"*": 50,
 		},
+		WorkspaceClasses: []WorkspaceClass{


Is this the config we want to deliver for Self-Hosted? 🤔

Good question. @kylos101 @atduarte Are we ok with these workspace classes for self-hosted?

Don't think we would want to have the two workspace classes as default for Self-Hosted. It's an advanced feature and the initial installation should be as simple as possible imho.

Would it be hard to have the default for self-hosted only be the standard?

cc @lucasvaltl as he is responsible for defining the self-hosted offering

I think the idea was to deliver what we currently do for SH: one "default" class. This config should then be exposed under experimental.webapp.workspaceClasses, and the concrete values set here.

@geropl agreed, thanks for linking to the concrete config in ops, too

Yeah default for self-hosted for now should be a single workspace class - to keep installation simple. Right now even that class is not made obvious - but is rather just a default that sets a request but no limits.

We should however think about how to properly allow for configuration of this (and #10805 is likely a better place to discuss this). Fwiw, I don't think it makes sense to make this part of the installation config - this might be something a user wants to change over time, specifically a user that is not the "installer persona" but rather an "project configurer" / an admin. It is likely better to expose this in the admin UI or team settings page.

components/dashboard/src/settings/selectClass.tsx

geropl · 2022-07-19T07:54:48Z

components/server/src/workspace/workspace-starter.ts

+                    }
+
+                    if (!workspaceClass) {
+                        workspaceClass = this.config.workspaceClasses.find((cl) => cl.isDefault)?.id ?? "";


I feel this should be in a function inside a namesapce WorkspaceClasses so that we can test it etc.
@Furisto Let me find a couple of minutes and I can provide a commit to show what I mean.

@Furisto Here is a commit showing what I mean: 7412eb0

I think it make sense to incorporate that commit + exposing of that config under "experimental" into this PR, and then we should be fine to merge. ✔️

☁️ Ideally we should also have tests for those functions.

Furisto · 2022-07-19T12:33:47Z

@geropl PTAL

geropl · 2022-07-20T06:32:08Z

install/installer/pkg/config/v1/experimental/experimental.go

@@ -210,6 +211,14 @@ type UsageConfig struct {
 	CreditsPerMinuteByWorkspaceClass map[string]float64 `json:"creditsPerMinuteByWorkspaceClass"`
 }

+type WebAppWorkspaceClass struct {


geropl

Code LGTM (as discussed), tested and work as expected. 🎉

Note that:

I could not test "g1-large" because preview envs now contain a single class only ✔️ (the UI still allows to select two classes, which we should clean up, by making it dynamic based on the config, in a follow up PR, before the SH release as discussed here /cc @lucasvaltl )
I did test default -> g1-standard after enabling the feature flag and the other scenarios ✔️
on workspace stop, I always got this error: container workspace completed; containers of a workspace pod are not supposed to do that. Reason: But I assume it's independent of this PR

Really looking forward to have this in prod! 🧡

- Use latest workspace instance to set workspace class - Add more detailed configuration for workspace classes - Make workspace classes configurable in installer

Pothulapati

So, I tried this on a self-hosted instance with default settings (using local-preview. This part of the build so not that hard to test. Just using the relevant build image should be enough)

I get two instances on the preferences settings
But setting them/changing them does not seem to do anything and always give me a default workspace class

/ # kubectl describe pod -l workspaceType=regular | grep workspaceClass
              gitpod.io/workspaceClass=default
              gitpod.io/workspaceClass=default

So, We should not even be having the preferences option then right? seems like they seem to be set in the UI https://github.com/gitpod-io/gitpod/blob/main/components/dashboard/src/settings/selectClass.tsx#L50. Shouldn't it instead be based on a config?

This could be a separate PR. Approving this hence.

/hold just in case.

Furisto · 2022-07-21T08:09:50Z

@Pothulapati That's right. There will be a separate PR for dynamically displaying the workspace classes.

Furisto · 2022-07-21T08:09:57Z

/unhold

roboquat added do-not-merge/work-in-progress do-not-merge/release-note-label-needed size/M labels Jul 12, 2022

Furisto force-pushed the fo/use-classes branch from 37f3463 to 3a97d39 Compare July 12, 2022 12:19

roboquat added size/L and removed size/M labels Jul 12, 2022

Furisto force-pushed the fo/use-classes branch from 7ffdcec to 345bc93 Compare July 12, 2022 16:53

roboquat added size/M size/L size/XL and removed size/L size/M labels Jul 12, 2022

Furisto force-pushed the fo/use-classes branch 2 times, most recently from 40606c7 to bfeb6ba Compare July 13, 2022 10:02

roboquat added release-note-none and removed do-not-merge/release-note-label-needed labels Jul 13, 2022

Furisto force-pushed the fo/use-classes branch from bfeb6ba to 0c74326 Compare July 13, 2022 12:08

Furisto marked this pull request as ready for review July 13, 2022 12:56

Furisto requested a review from a team July 13, 2022 12:56

roboquat removed the do-not-merge/work-in-progress label Jul 13, 2022

github-actions bot added the team: webapp Issue belongs to the WebApp team label Jul 13, 2022

geropl reviewed Jul 15, 2022

View reviewed changes

components/server/src/workspace/workspace-starter.ts Outdated Show resolved Hide resolved

geropl reviewed Jul 15, 2022

View reviewed changes

components/gitpod-db/src/typeorm/entity/db-workspace.ts Outdated Show resolved Hide resolved

geropl reviewed Jul 15, 2022

View reviewed changes

install/installer/pkg/components/server/configmap.go Outdated Show resolved Hide resolved

Furisto force-pushed the fo/use-classes branch from 75d851f to 2e777e2 Compare July 15, 2022 12:01

geropl self-assigned this Jul 15, 2022

geropl reviewed Jul 19, 2022

View reviewed changes

components/server/src/config.ts Outdated Show resolved Hide resolved

geropl reviewed Jul 19, 2022

View reviewed changes

components/server/src/workspace/workspace-starter.ts Show resolved Hide resolved

geropl reviewed Jul 19, 2022

View reviewed changes

components/dashboard/src/settings/selectClass.tsx Outdated Show resolved Hide resolved

geropl reviewed Jul 19, 2022

View reviewed changes

Furisto force-pushed the fo/use-classes branch from 0ecd6f4 to d707320 Compare July 19, 2022 11:48

Furisto requested a review from a team July 19, 2022 11:48

github-actions bot added the team: delivery Issue belongs to the self-hosted team label Jul 19, 2022

Furisto force-pushed the fo/use-classes branch from d707320 to 880df41 Compare July 19, 2022 12:09

geropl reviewed Jul 20, 2022

View reviewed changes

geropl approved these changes Jul 20, 2022

View reviewed changes

Furisto added 5 commits July 20, 2022 08:39

[installer] Configure default workspace class

e027b02

[server] Add debug script

1e50fce

[gitpod-db] Add class column to workspace table

d427cdb

[server] Set workspace class based on user preference

e77a14c

[server] Ensure old workspaces can be started

c261a91

Furisto force-pushed the fo/use-classes branch from 880df41 to 543cb2c Compare July 20, 2022 08:39

Furisto and others added 2 commits July 20, 2022 18:08

Incorporate review feedback

f161ee2

- Use latest workspace instance to set workspace class - Add more detailed configuration for workspace classes - Make workspace classes configurable in installer

[server] Use WorkspaceClassesConfig

fd52a76

Furisto force-pushed the fo/use-classes branch from 543cb2c to fd52a76 Compare July 20, 2022 18:10

Pothulapati approved these changes Jul 21, 2022

View reviewed changes

roboquat added the do-not-merge/hold label Jul 21, 2022

roboquat removed the do-not-merge/hold label Jul 21, 2022

roboquat merged commit 53e47b2 into main Jul 21, 2022

roboquat deleted the fo/use-classes branch July 21, 2022 08:10

roboquat added the deployed: webapp Meta team change is running in production label Jul 26, 2022

Furisto added the feature: workspace classes label Aug 27, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Set workspace class based on user preference #11313

Set workspace class based on user preference #11313

Furisto commented Jul 12, 2022 •

edited

Furisto commented Jul 13, 2022 •

edited by werft-gitpod-dev-com bot

Furisto commented Jul 13, 2022 •

edited by werft-gitpod-dev-com bot

Furisto commented Jul 15, 2022

geropl Jul 19, 2022

Furisto Jul 19, 2022

atduarte Jul 19, 2022

geropl Jul 19, 2022 •

edited

kylos101 Jul 19, 2022

lucasvaltl Jul 19, 2022 •

edited

geropl Jul 19, 2022

geropl Jul 19, 2022

Furisto commented Jul 19, 2022

geropl Jul 20, 2022

geropl left a comment

Pothulapati left a comment •

edited

Furisto commented Jul 21, 2022

Furisto commented Jul 21, 2022

Set workspace class based on user preference #11313

Set workspace class based on user preference #11313

Conversation

Furisto commented Jul 12, 2022 • edited

Description

Related Issue(s)

How to test

Release Notes

Werft options:

Furisto commented Jul 13, 2022 • edited by werft-gitpod-dev-com bot

Furisto commented Jul 13, 2022 • edited by werft-gitpod-dev-com bot

Furisto commented Jul 15, 2022

geropl Jul 19, 2022

Choose a reason for hiding this comment

Furisto Jul 19, 2022

Choose a reason for hiding this comment

atduarte Jul 19, 2022

Choose a reason for hiding this comment

geropl Jul 19, 2022 • edited

Choose a reason for hiding this comment

kylos101 Jul 19, 2022

Choose a reason for hiding this comment

lucasvaltl Jul 19, 2022 • edited

Choose a reason for hiding this comment

geropl Jul 19, 2022

Choose a reason for hiding this comment

geropl Jul 19, 2022

Choose a reason for hiding this comment

Furisto commented Jul 19, 2022

geropl Jul 20, 2022

Choose a reason for hiding this comment

geropl left a comment

Choose a reason for hiding this comment

Pothulapati left a comment • edited

Choose a reason for hiding this comment

Furisto commented Jul 21, 2022

Furisto commented Jul 21, 2022

Furisto commented Jul 12, 2022 •

edited

Furisto commented Jul 13, 2022 •

edited by werft-gitpod-dev-com bot

Furisto commented Jul 13, 2022 •

edited by werft-gitpod-dev-com bot

geropl Jul 19, 2022 •

edited

lucasvaltl Jul 19, 2022 •

edited

Pothulapati left a comment •

edited