[jb] enable vmoptions config in .gitpod.yml #10768

yaohui-wyh · 2022-06-20T13:15:16Z

Description

Add vmoptions in gitpod schema (.gitpod.yml).

jetbrains:
  intellij:
    vmoptions: "-Xmx4g"
  goland:
    vmoptions: "-Xmx3g"

This is a follow-up PR with [jb] configure vmoptions for intellij backend server #10175
Schema description text is borrowed from https://www.jetbrains.com/help/idea/remote-development-a.html#rd_add_vm_options
VMOptions specified by project level .gitpod.yml have higher priority than user's environment variables. Suppose we have a workspace with:
- project level .gitpod.yml: jetbrains.intellij.vmoptions = "-Xmx4g"
- Gitpod user preferences INTELLIJ_VMOPTIONS EnvVar set to -Xmx3g -Didea.is.internal=true
- the final effective VMOptions will be -Didea.is.internal=true -Xmx4g

Related Issue(s)

Remedy for #8704

How to test

Build & test status from a Gitpod workspace

Start Gitpod workspace from this PR: https://gitpod.io/#https://github.com/gitpod-io/gitpod/pull/10768
Modify project's .gitpod.yml and insert a jetbrains.intellij.vmoptions field with value "-Xmx4g"
Launch a new Terminal and build the status binary: cd /workspace/gitpod/components/ide/jetbrains/image/status && go build. Replace the status binary: rm /ide-desktop/status; cp status /ide-desktop/status
Kill the status process: ps aux | grep status; kill -9 <pid>
(supervisor restart status immediately) Check JetBrains IDE server VMOptions: jps -mlv | grep intellij | grep -i xmx

Expected result:

IDE Server should be running with -Xmx4g

Release Notes


- Allow customize VMOptions for JetBrains backend server, by setting "vmoptions" in .gitpod.yml

Documentation

components/gitpod-protocol/data/gitpod-schema.json

components/ide/jetbrains/image/status/main.go

akosyakov · 2022-06-21T07:45:14Z

@yaohui-wyh I left some comment could you address please? We will need also a PR for docs which:

explain how to configure VM options for all JB IDEs, i.e. on https://www.gitpod.io/docs/ides-and-editors/intellij You can mention upstream link there.
and in reference docs, like for plugins: https://www.gitpod.io/docs/references/gitpod-yml#jetbrainsproductplugins

Don't forget to mention everywhere that this functionality is alpha and the can leave feedback about performance on #8704

yaohui-wyh · 2022-06-21T09:12:13Z

@yaohui-wyh I left some comment could you address please? We will need also a PR for docs which:

explain how to configure VM options for all JB IDEs, i.e. on https://www.gitpod.io/docs/ides-and-editors/intellij You can mention upstream link there.

and in reference docs, like for plugins: https://www.gitpod.io/docs/references/gitpod-yml#jetbrainsproductplugins

Don't forget to mention everywhere that this functionality is alpha and the can leave feedback about performance on #8704

Sure, I'm glad to add a PR for docs :)

components/ide/jetbrains/image/status/main.go

akosyakov · 2022-06-22T06:53:59Z

/werft run

👍 started the job as gitpod-build-yh-vmoptions-fork.0
(with .werft/ from main)

akosyakov · 2022-06-22T06:58:16Z

@yaohui-wyh Could you have a look the build does not pass:

[components/local-app:app-linux-amd64] ?   	github.com/gitpod-io/local-app/pkg/bastion	[no test files]
[components/ide/jetbrains/image/status:app] === RUN   TestGetProductConfig
[components/ide/jetbrains/image/status:app] --- PASS: TestGetProductConfig (0.00s)
[components/ide/jetbrains/image/status:app] === RUN   TestParseGitpodConfig
[components/ide/jetbrains/image/status:app] --- FAIL: TestParseGitpodConfig (0.00s)
[components/ide/jetbrains/image/status:app] panic: runtime error: invalid memory address or nil pointer dereference [recovered]
[components/ide/jetbrains/image/status:app] 	panic: runtime error: invalid memory address or nil pointer dereference
[components/ide/jetbrains/image/status:app] [signal SIGSEGV: segmentation violation code=0x1 addr=0x78 pc=0x8d0e73]
[components/ide/jetbrains/image/status:app] 
[components/ide/jetbrains/image/status:app] goroutine 19 [running]:
[components/ide/jetbrains/image/status:app] testing.tRunner.func1.2({0x942fc0, 0xe0a2f0})
[components/ide/jetbrains/image/status:app] 	/home/gitpod/go/src/testing/testing.go:1389 +0x24e
[components/ide/jetbrains/image/status:app] testing.tRunner.func1()
[components/ide/jetbrains/image/status:app] 	/home/gitpod/go/src/testing/testing.go:1392 +0x39f
[components/ide/jetbrains/image/status:app] panic({0x942fc0, 0xe0a2f0})
[components/ide/jetbrains/image/status:app] 	/home/gitpod/go/src/runtime/panic.go:838 +0x207
[components/ide/jetbrains/image/status:app] github.com/gitpod-io/gitpod/jetbrains/status.TestParseGitpodConfig(0xc0001f09c0?)
[components/ide/jetbrains/image/status:app] 	/tmp/build/components-ide-jetbrains-image-status--app.0302babf4fd947cf7d430a788af95a341797b22b/main_test.go:32 +0x33
[components/ide/jetbrains/image/status:app] testing.tRunner(0xc0001f1040, 0xa22f50)
[components/ide/jetbrains/image/status:app] 	/home/gitpod/go/src/testing/testing.go:1439 +0x102
[components/ide/jetbrains/image/status:app] created by testing.(*T).Run
[components/ide/jetbrains/image/status:app] 	/home/gitpod/go/src/testing/testing.go:1486 +0x35f
[components/ide/jetbrains/image/status:app] FAIL	github.com/gitpod-io/gitpod/jetbrains/status	0.099s
[components/ide/jetbrains/image/status:app] FAIL
[components/ide/jetbrains/image/status:app] package build failed
[components/ide/jetbrains/image/status:app] Reason: exit status 1

yaohui-wyh · 2022-06-22T07:22:03Z

Could you have a look the build does not pass

Hi @akosyakov Could you please rerun the CI job? I assume missing deps at BUILD.yaml caused the failure (since go test passed). If CI passed, I would rebase the commits and force push again.

akosyakov · 2022-06-22T07:40:29Z

/werft run

👍 started the job as gitpod-build-yh-vmoptions-fork.1
(with .werft/ from main)

akosyakov · 2022-06-22T08:50:30Z

/werft run with-preview

👍 started the job as gitpod-build-yh-vmoptions-fork.2
(with .werft/ from main)

akosyakov

it works nicely, tested that plugins are still working as well.

loujaybee

@akosyakov I have a couple of questions on this one...

How can we provide guidance to users on the appropriate settings to set relative to their workspace spec? Considering self-hosted VM’s being potentially different configurations to SaaS?
Is the .gitpod.yml the right place to have this API/abstraction? Does this not couple closely the project configuration with the underlying machine characteristics, e.g. what considerations should we take for workspace classes?

EDIT: Just noticed that we're identifying as alpha [1]

akosyakov · 2022-06-22T10:58:01Z

I have a couple of questions on this one...

An idea is to detect a user change to the actual max heap size in the backend plugin and suggest a user to put in .gitpod.yml to persist. So the flow would be like:

a user starts using with default Xmx
experience perf issues and follow notifications to upgrade Xmx of the running instance
after JB backend restart there will be a warning on .gitpod.yml that Xmx of the running instance was changed, but it should be applied to .gitpod.yml to be persistent

I think workspace classes is a bit orthogonal, we will need to evaluate whether configured Xmx in .gitpod.yml can be managed by the current workspace class, i.e. recommendation that JB backend should not be allowed to use more than 60% process of the total allowed memory. If it happens as a remedy we should suggest not only update Xmx but upgrade to the bigger workspace class.

akosyakov · 2022-06-22T11:27:23Z

@loujaybee just to clarify, here VM is JVM, it is a project characteristic which does not change from hardware on which you run, i.e. if you need 4096 JVM max heap size to load a project it will be the same whether you run on SaaS, Self-Hosted or in your local docker container. vmoptions is coming from JB terminology

components/gitpod-protocol/data/gitpod-schema.json

andrew-farries

👍 I'll leave @akosyakov to assess the IDE changes. I have just one question about naming of the options.

/hold

components/gitpod-protocol/data/gitpod-schema.json

akosyakov · 2022-06-24T06:44:28Z

/werft run

👍 started the job as gitpod-build-yh-vmoptions-fork.3
(with .werft/ from main)

akosyakov · 2022-06-25T05:40:33Z

/unhold

roboquat added release-note do-not-merge/work-in-progress size/L labels Jun 20, 2022

yaohui-wyh marked this pull request as ready for review June 21, 2022 02:19

yaohui-wyh requested review from a team June 21, 2022 02:20

roboquat removed the do-not-merge/work-in-progress label Jun 21, 2022

akosyakov reviewed Jun 21, 2022

View reviewed changes

components/gitpod-protocol/data/gitpod-schema.json Outdated Show resolved Hide resolved

akosyakov reviewed Jun 21, 2022

View reviewed changes

components/ide/jetbrains/image/status/main.go Outdated Show resolved Hide resolved

yaohui-wyh force-pushed the yh/vmoptions branch from a8c824b to df113fc Compare June 21, 2022 09:25

akosyakov reviewed Jun 22, 2022

View reviewed changes

components/ide/jetbrains/image/status/main.go Outdated Show resolved Hide resolved

components/ide/jetbrains/image/status/main.go Outdated Show resolved Hide resolved

components/ide/jetbrains/image/status/main.go Outdated Show resolved Hide resolved

akosyakov approved these changes Jun 22, 2022

View reviewed changes

yaohui-wyh force-pushed the yh/vmoptions branch from 89539a3 to 49f5135 Compare June 22, 2022 09:48

loujaybee reviewed Jun 22, 2022

View reviewed changes

loujaybee requested a review from a team June 22, 2022 11:59

akosyakov reviewed Jun 23, 2022

View reviewed changes

components/gitpod-protocol/data/gitpod-schema.json Outdated Show resolved Hide resolved

[jb] enable vmoptions config in .gitpod.yml

bd8f35a

yaohui-wyh force-pushed the yh/vmoptions branch from b65c1f5 to bd8f35a Compare June 23, 2022 05:37

andrew-farries approved these changes Jun 24, 2022

View reviewed changes

components/gitpod-protocol/data/gitpod-schema.json Show resolved Hide resolved

roboquat added the do-not-merge/hold label Jun 24, 2022

roboquat removed the do-not-merge/hold label Jun 25, 2022

roboquat merged commit f6f894f into gitpod-io:main Jun 25, 2022

yaohui-wyh mentioned this pull request Jun 29, 2022

[jb] check maxHeapSize of IDE server and guide users to set vmoptions in .gitpod.yml #11002

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[jb] enable vmoptions config in .gitpod.yml #10768

[jb] enable vmoptions config in .gitpod.yml #10768

yaohui-wyh commented Jun 20, 2022 •

edited by akosyakov

Loading

akosyakov commented Jun 21, 2022

yaohui-wyh commented Jun 21, 2022

akosyakov commented Jun 22, 2022 •

edited by werft-gitpod-dev-com bot

Loading

akosyakov commented Jun 22, 2022

yaohui-wyh commented Jun 22, 2022

akosyakov commented Jun 22, 2022 •

edited by werft-gitpod-dev-com bot

Loading

akosyakov commented Jun 22, 2022 •

edited by werft-gitpod-dev-com bot

Loading

akosyakov left a comment

loujaybee left a comment •

edited

Loading

akosyakov commented Jun 22, 2022 •

edited

Loading

akosyakov commented Jun 22, 2022 •

edited

Loading

andrew-farries left a comment

akosyakov commented Jun 24, 2022 •

edited by werft-gitpod-dev-com bot

Loading

akosyakov commented Jun 25, 2022

[jb] enable vmoptions config in .gitpod.yml #10768

[jb] enable vmoptions config in .gitpod.yml #10768

Conversation

yaohui-wyh commented Jun 20, 2022 • edited by akosyakov Loading

Description

Related Issue(s)

How to test

Release Notes

Documentation

akosyakov commented Jun 21, 2022

yaohui-wyh commented Jun 21, 2022

akosyakov commented Jun 22, 2022 • edited by werft-gitpod-dev-com bot Loading

akosyakov commented Jun 22, 2022

yaohui-wyh commented Jun 22, 2022

akosyakov commented Jun 22, 2022 • edited by werft-gitpod-dev-com bot Loading

akosyakov commented Jun 22, 2022 • edited by werft-gitpod-dev-com bot Loading

akosyakov left a comment

Choose a reason for hiding this comment

loujaybee left a comment • edited Loading

Choose a reason for hiding this comment

akosyakov commented Jun 22, 2022 • edited Loading

akosyakov commented Jun 22, 2022 • edited Loading

andrew-farries left a comment

Choose a reason for hiding this comment

akosyakov commented Jun 24, 2022 • edited by werft-gitpod-dev-com bot Loading

akosyakov commented Jun 25, 2022

yaohui-wyh commented Jun 20, 2022 •

edited by akosyakov

Loading

akosyakov commented Jun 22, 2022 •

edited by werft-gitpod-dev-com bot

Loading

akosyakov commented Jun 22, 2022 •

edited by werft-gitpod-dev-com bot

Loading

akosyakov commented Jun 22, 2022 •

edited by werft-gitpod-dev-com bot

Loading

loujaybee left a comment •

edited

Loading

akosyakov commented Jun 22, 2022 •

edited

Loading

akosyakov commented Jun 22, 2022 •

edited

Loading

akosyakov commented Jun 24, 2022 •

edited by werft-gitpod-dev-com bot

Loading