gp rebuild with isolated debug workspace #15795

akosyakov · 2023-01-17T11:14:16Z

Description

This approach creates an isolated debug workspace within the existing workspace using the docker run command. To access the debug workspace, a user adds the prefix debug- to the original workspace ID and uses the new ID as the debug workspace ID. See [1)] to learn more about the usage.

Both the original and debug workspaces share the same workspace, Docker, supervisor, and IDE mounts, but have separate networks. The debug workspace runs an HTTP proxy and SSH server to enable access. The workspace proxy uses the debug- prefix to forward traffic to the corresponding workspace.

Related Issue(s)

Related to #7671

How to test

Start a workspace and then follow [1] to use gp rebuild
It should work with VS Code Browser and Desktop (with latest version of extensions).
JB changes are in for the launcher, but it is hard to test in preview evns. We will test in production and improve later.

Release Notes

Allow to test the workspace configuration changes within the current workspace with gp rebuild.

Documentation

Build Options:

/werft with-github-actions
Experimental feature to run the build with GitHub Actions (and not in Werft).
/werft with-local-preview
If enabled this will build install/preview
/werft with-preview
/werft with-large-vm
/werft analytics=segment
/werft with-integration-tests=all
Valid options are all, workspace, webapp, ide, jetbrains, vscode, ssh

werft-gitpod-dev-com · 2023-01-17T11:31:42Z

started the job as gitpod-build-ak-rebuild-debug.1 because the annotations in the pull request description changed
(with .werft/ from main)

akosyakov · 2023-01-17T12:05:39Z

/werft run

👍 started the job as gitpod-build-ak-rebuild-debug.2
(with .werft/ from main)

akosyakov · 2023-01-17T20:05:37Z

/werft run

👍 started the job as gitpod-build-ak-rebuild-debug.14
(with .werft/ from main)

akosyakov · 2023-01-17T21:45:08Z

/werft run recreate-vm=true

👍 started the job as gitpod-build-ak-rebuild-debug.18
(with .werft/ from main)

akosyakov · 2023-01-18T08:55:20Z

/werft run with-clean-slate-deployment=true

👍 started the job as gitpod-build-ak-rebuild-debug.19
(with .werft/ from main)

kylos101 · 2023-02-03T15:25:34Z

@akosyakov in df00d55, why FROM gitpod/workspace-full:latest, instead of FROM gitpod/workspace-base:latest? Just curious, I'm not suggesting workspace-base, more curious.

akosyakov · 2023-02-03T15:28:54Z

@akosyakov in df00d55, why FROM gitpod/workspace-full:latest, instead of FROM gitpod/workspace-base:latest? Just curious, I'm not suggesting workspace-base, more curious.

@kylos101 It should apply the same default image which we put in outer loop. it is workspace-full right?

kylos101 · 2023-02-03T15:37:46Z

@akosyakov in df00d55, why FROM gitpod/workspace-full:latest, instead of FROM gitpod/workspace-base:latest? Just curious, I'm not suggesting workspace-base, more curious.

@kylos101 It should apply the same default image which we put in outer loop. it is workspace-full right?

Good question! I'm not sure, honestly.

For example, the outer loop workspace image can be the default gitpod/workspace-full:latest (which is what happens if the customer doesn't override, or if their overridden image build fails, then they can opt to use the default, which is gitpod/workspace-full:latest).

To recap, customers can specify their own image in the following ways:

a custom image
a private image
a specific tag for gitpod/workspace-full
Or use a different base image, like gitpod/workspace-base:latest

I'm not sure on the use cases for the debug workspace. How useful is the debug workspace, if it doesn't include the customer's intended image/customizations? If it doesn't "need" to use the same workspace image as the outer loop, then gitpod/workspace-full-latest should be fine.

akosyakov · 2023-02-03T15:39:07Z

To recap, customers can specify their own image in the following ways:

In this PR we only use gitpod/workspace-full:latest as a fallback after parsing .gitpod.yml and trying all other variants.

kylos101 · 2023-02-03T15:52:29Z

To recap, customers can specify their own image in the following ways:

In this PR we only use gitpod/workspace-full:latest as a fallback after parsing .gitpod.yml and trying all other variants.

Thank you for clarifying, @akosyakov ! That helps. 😃

It looks like you're still making changes as of an hour ago, and this is in a draft state, so I'll hold off on approvals for now.

akosyakov · 2023-02-03T16:02:11Z

It's ready. I put hold to actually deploy only on Monday. @iQQBot could you check that we did not overlook something what will break stable features 🙏

Lou wants to start UX testing on Monday after 15 CET. It would be cool to deploy before.

/hold

iQQBot · 2023-02-06T07:16:14Z

/werft run

👍 started the job as gitpod-build-ak-rebuild-debug.85
(with .werft/ from main)

iQQBot

LGTM

iQQBot · 2023-02-06T07:19:17Z

components/supervisor/pkg/supervisor/supervisor.go

@@ -239,6 +236,9 @@ func Run(options ...RunOption) {
 	if cfg.DesktopIDE != nil {
 		internalPorts = append(internalPorts, desktopIDEPort)
 	}
+	if cfg.isDebugWorkspace() {


do we want to also mark 24999-25003 internal?

Do you mean in the outer container? I don't think so, we don't reserve these ports. They can be used if gp rebuild is not running. If it is running I would prefer to be explicit and maybe provide supervisor api that gp rebuild could add name/description for such ports.

iQQBot · 2023-02-06T07:35:42Z

/werft run with-integration-tests=workspace

👍 started the job as gitpod-build-ak-rebuild-debug.87
(with .werft/ from main)

akosyakov · 2023-02-06T08:54:15Z

/unhold

Co-authored-by: Pudong Zheng <[email protected]>

akosyakov · 2023-02-06T10:34:02Z

@csweichel We need a tick from you to land? 🙏

roboquat added do-not-merge/work-in-progress do-not-merge/release-note-label-needed size/L labels Jan 17, 2023

akosyakov force-pushed the ak/rebuild_debug branch 2 times, most recently from c6bea97 to 927a56a Compare January 17, 2023 15:13

roboquat added size/XL and removed size/L labels Jan 17, 2023

akosyakov force-pushed the ak/rebuild_debug branch 4 times, most recently from c8142cc to 95c326f Compare January 17, 2023 16:12

roboquat added size/XXL and removed size/XL labels Jan 17, 2023

akosyakov force-pushed the ak/rebuild_debug branch 5 times, most recently from 1db92b2 to 34cd6d6 Compare January 17, 2023 20:02

akosyakov force-pushed the ak/rebuild_debug branch 3 times, most recently from 538b192 to 8ecfb2f Compare January 17, 2023 21:45

akosyakov force-pushed the ak/rebuild_debug branch 4 times, most recently from 227f746 to 63a9247 Compare January 18, 2023 15:34

akosyakov marked this pull request as ready for review February 3, 2023 16:00

akosyakov requested a review from a team February 3, 2023 16:00

akosyakov requested a review from csweichel as a code owner February 3, 2023 16:00

akosyakov requested a review from a team February 3, 2023 16:00

roboquat removed the do-not-merge/work-in-progress label Feb 3, 2023

github-actions bot added team: workspace Issue belongs to the Workspace team team: IDE labels Feb 3, 2023

roboquat added the do-not-merge/hold label Feb 3, 2023

iQQBot approved these changes Feb 6, 2023

View reviewed changes

akosyakov force-pushed the ak/rebuild_debug branch from df00d55 to cea7a83 Compare February 6, 2023 08:53

roboquat removed the do-not-merge/hold label Feb 6, 2023

gp rebuild with isolated debug workspace

d6ebdf0

Co-authored-by: Pudong Zheng <[email protected]>

akosyakov force-pushed the ak/rebuild_debug branch from cea7a83 to d6ebdf0 Compare February 6, 2023 09:08

WVerlaek approved these changes Feb 6, 2023

View reviewed changes

csweichel approved these changes Feb 6, 2023

View reviewed changes

roboquat merged commit 9b3f8a2 into main Feb 6, 2023

roboquat deleted the ak/rebuild_debug branch February 6, 2023 13:47

roboquat added deployed: IDE IDE change is running in production deployed: workspace Workspace team change is running in production deployed Change is completely running in production labels Feb 6, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

gp rebuild with isolated debug workspace #15795

gp rebuild with isolated debug workspace #15795

akosyakov commented Jan 17, 2023 •

edited

Loading

werft-gitpod-dev-com bot commented Jan 17, 2023

akosyakov commented Jan 17, 2023 •

edited by werft-gitpod-dev-com bot

Loading

akosyakov commented Jan 17, 2023 •

edited by werft-gitpod-dev-com bot

Loading

akosyakov commented Jan 17, 2023 •

edited by werft-gitpod-dev-com bot

Loading

akosyakov commented Jan 18, 2023 •

edited by werft-gitpod-dev-com bot

Loading

kylos101 commented Feb 3, 2023

akosyakov commented Feb 3, 2023

kylos101 commented Feb 3, 2023 •

edited

Loading

akosyakov commented Feb 3, 2023

kylos101 commented Feb 3, 2023

akosyakov commented Feb 3, 2023 •

edited by werft-gitpod-dev-com bot

Loading

iQQBot commented Feb 6, 2023 •

edited by werft-gitpod-dev-com bot

Loading

iQQBot left a comment

iQQBot Feb 6, 2023

akosyakov Feb 6, 2023

iQQBot commented Feb 6, 2023 •

edited by werft-gitpod-dev-com bot

Loading

akosyakov commented Feb 6, 2023

akosyakov commented Feb 6, 2023 •

edited

Loading

gp rebuild with isolated debug workspace #15795

gp rebuild with isolated debug workspace #15795

Conversation

akosyakov commented Jan 17, 2023 • edited Loading

Description

Related Issue(s)

How to test

Release Notes

Documentation

Build Options:

werft-gitpod-dev-com bot commented Jan 17, 2023

akosyakov commented Jan 17, 2023 • edited by werft-gitpod-dev-com bot Loading

akosyakov commented Jan 17, 2023 • edited by werft-gitpod-dev-com bot Loading

akosyakov commented Jan 17, 2023 • edited by werft-gitpod-dev-com bot Loading

akosyakov commented Jan 18, 2023 • edited by werft-gitpod-dev-com bot Loading

kylos101 commented Feb 3, 2023

akosyakov commented Feb 3, 2023

kylos101 commented Feb 3, 2023 • edited Loading

akosyakov commented Feb 3, 2023

kylos101 commented Feb 3, 2023

akosyakov commented Feb 3, 2023 • edited by werft-gitpod-dev-com bot Loading

iQQBot commented Feb 6, 2023 • edited by werft-gitpod-dev-com bot Loading

iQQBot left a comment

Choose a reason for hiding this comment

iQQBot Feb 6, 2023

Choose a reason for hiding this comment

akosyakov Feb 6, 2023

Choose a reason for hiding this comment

iQQBot commented Feb 6, 2023 • edited by werft-gitpod-dev-com bot Loading

akosyakov commented Feb 6, 2023

akosyakov commented Feb 6, 2023 • edited Loading

akosyakov commented Jan 17, 2023 •

edited

Loading

akosyakov commented Jan 17, 2023 •

edited by werft-gitpod-dev-com bot

Loading

akosyakov commented Jan 17, 2023 •

edited by werft-gitpod-dev-com bot

Loading

akosyakov commented Jan 17, 2023 •

edited by werft-gitpod-dev-com bot

Loading

akosyakov commented Jan 18, 2023 •

edited by werft-gitpod-dev-com bot

Loading

kylos101 commented Feb 3, 2023 •

edited

Loading

akosyakov commented Feb 3, 2023 •

edited by werft-gitpod-dev-com bot

Loading

iQQBot commented Feb 6, 2023 •

edited by werft-gitpod-dev-com bot

Loading

iQQBot commented Feb 6, 2023 •

edited by werft-gitpod-dev-com bot

Loading

akosyakov commented Feb 6, 2023 •

edited

Loading