Describe running and debugging plugins in sidecars #803

tsmaeder · 2020-07-13T11:59:04Z

Signed-off-by: Thomas Mäder [email protected]

What does this PR do?

Describes workflows for working with plugins in sidecar containers in detail.

What issues does this PR fix or reference?

eclipse-che/che#13249

che-bot · 2020-07-13T12:23:04Z

✅ E2E Happy path tests succeed 🎉

See Details

name	link
che-theia	docker.io/maxura/che-theia:803
che-theia-endpoint-runtime-binary	docker.io/maxura/che-theia-endpoint-runtime-binary:803

Tested with Eclipse Che Single User on K8S (minikube v1.1.1)

sunix · 2020-07-13T15:25:06Z

CONTRIBUTING.md

+    {
+        "type": "node",
+        "request": "attach",
+        "name": "Java",


Naming it Java is confusing in IMO, maybe vscodejava is more appropriate?

CONTRIBUTING.md

ericwill · 2020-07-15T16:55:10Z

CONTRIBUTING.md

-But please note, you have to restart server to which changes is made.
+# Working with Plugins in Sidecars
+
+In a real Che workspace, many plugins are run in their own "sidecar" container. The idea is that the container furnishes any "native" dependencies the the plugins needs. For example the container that runs the theia IDE back end does not contain a Java SDK, so in order to run a plugin that needs a Java installation, we'll run the plugin inside a container that has Java installed.


the the plugins needs -> the plugin needs

ericwill · 2020-07-15T16:56:58Z

CONTRIBUTING.md

+
+## Setting up plugins to run
+
+We can now add plugins to run in the sidecar container by adding them to the folder `/projects/plugins-1`(or whaterver we define as `THEIA_PLUGINS`env variable). If we're just interested in debugging the theia plugins host process, we can download a *.vsix file to the folder: it will be unpacked to a subfolder of `/tmp`. If we need to debug the plugin, we can checkout the source code and built it according the the instructions for the plugin:


and built it -> and build it

ericwill · 2020-07-27T20:20:12Z

@tsmaeder can we get this one merged before the sprint is out?

benoitf · 2020-07-31T08:11:18Z

FYI, would be nice to fix vale errors (the plug-in used when working on che documentation)

benoitf · 2020-07-31T08:20:13Z

CONTRIBUTING.md

+
+This way, the IDE and the remote plugin host process can find each other.
+
+The container in question must be able to work as a plugin sidecar for any plugin you want to run in it. If you are trying to debug a plugin that already has a sidecar container, it would make sense to base `remote-1`container on the sidecar that runs the original plugin. In that case, you would have to add a copy of node to sidecar container, since they generally don't contain one and we need to run the runtime host process, which is a node application. In this case, however, I've started with a `theia-dev`image and just point it to a JDK I've copied to `/projects/java-11-openjdk`by setting `JAVA_HOME`.


Suggested change

The container in question must be able to work as a plugin sidecar for any plugin you want to run in it. If you are trying to debug a plugin that already has a sidecar container, it would make sense to base `remote-1`container on the sidecar that runs the original plugin. In that case, you would have to add a copy of node to sidecar container, since they generally don't contain one and we need to run the runtime host process, which is a node application. In this case, however, I've started with a `theia-dev`image and just point it to a JDK I've copied to `/projects/java-11-openjdk`by setting `JAVA_HOME`.

The container in question must be able to work as a plugin sidecar for any plugin you want to run in it. If you are trying to debug a plugin that already has a sidecar container, it would make sense to base `remote-1` container on the sidecar that runs the original plugin. In that case, you would have to add a copy of node to sidecar container, since they generally don't contain one and we need to run the runtime host process, which is a node application. In this case, however, I've started with a `theia-dev` image and just point it to a JDK I've copied to `/projects/java-11-openjdk` by setting `JAVA_HOME`.

suggested change is just to add the extra space after closing words

benoitf · 2020-07-31T08:20:58Z

CONTRIBUTING.md

+
+The container in question must be able to work as a plugin sidecar for any plugin you want to run in it. If you are trying to debug a plugin that already has a sidecar container, it would make sense to base `remote-1`container on the sidecar that runs the original plugin. In that case, you would have to add a copy of node to sidecar container, since they generally don't contain one and we need to run the runtime host process, which is a node application. In this case, however, I've started with a `theia-dev`image and just point it to a JDK I've copied to `/projects/java-11-openjdk`by setting `JAVA_HOME`.
+
+If we want to debug later on, we'll have to add the `node-debug2`Che plugin to our workspace: 


Suggested change

If we want to debug later on, we'll have to add the `node-debug2`Che plugin to our workspace:

If we want to debug later on, we'll have to add the `node-debug2` Che plugin to our workspace:

benoitf · 2020-07-31T08:22:31Z

CONTRIBUTING.md

+
+## Setting up plugins to run
+
+We can now add plugins to run in the sidecar container by adding them to the folder `/projects/plugins-1`(or whaterver we define as `THEIA_PLUGINS`env variable). If we're just interested in debugging the theia plugins host process, we can download a *.vsix file to the folder: it will be unpacked to a subfolder of `/tmp`. If we need to debug the plugin, we can checkout the source code and build it according the the instructions for the plugin:


Suggested change

We can now add plugins to run in the sidecar container by adding them to the folder `/projects/plugins-1`(or whaterver we define as `THEIA_PLUGINS`env variable). If we're just interested in debugging the theia plugins host process, we can download a *.vsix file to the folder: it will be unpacked to a subfolder of `/tmp`. If we need to debug the plugin, we can checkout the source code and build it according the the instructions for the plugin:

We can now add plugins to run in the sidecar container by adding them to the folder `/projects/plugins-1` (or whaterver we define as `THEIA_PLUGINS` env variable). If we're just interested in debugging the theia plugins host process, we can download a *.vsix file or *.theia file to the folder: it will be unpacked to a subfolder of `/tmp`. If we need to debug the plugin, we can checkout the source code and build it according the the instructions for the plugin:

Long term, we're trying to de-emphasize the theia API. Plus, the only theia-format plugins I'm aware of are our own, which run in the theia container.

che-bot · 2020-07-31T08:24:30Z

✅ E2E Happy path tests succeed 🎉

See Details

name	link
che-theia	docker.io/maxura/che-theia:803
che-theia-endpoint-runtime-binary	docker.io/maxura/che-theia-endpoint-runtime-binary:803

Tested with Eclipse Che Single User on K8S (minikube v1.1.1)

che-bot · 2020-08-03T08:16:55Z

❌ E2E Happy path tests failed ❗

See Details

name	link
che-theia	docker.io/maxura/che-theia:803
che-theia-endpoint-runtime-binary	docker.io/maxura/che-theia-endpoint-runtime-binary:803

Tested with Eclipse Che Single User on K8S (minikube v1.1.1)

ℹ️ Use comment "crw-ci-test" to rerun happy path E2E test.

tsmaeder · 2020-08-04T08:01:41Z

crw-ci-test

benoitf · 2020-08-04T08:06:23Z

I think you need to rebase to current master first.

che-bot · 2020-08-04T08:27:34Z

✅ E2E Happy path tests succeed 🎉

See Details

name	link
che-theia	docker.io/maxura/che-theia:803
che-theia-endpoint-runtime-binary	docker.io/maxura/che-theia-endpoint-runtime-binary:803

Tested with Eclipse Che Single User on K8S (minikube v1.1.1)

Signed-off-by: Thomas Mäder <[email protected]>

che-bot · 2020-08-04T09:14:57Z

✅ E2E Happy path tests succeed 🎉

See Details

name	link
che-theia	docker.io/maxura/che-theia:803
che-theia-endpoint-runtime-binary	docker.io/maxura/che-theia-endpoint-runtime-binary:803

Tested with Eclipse Che Single User on K8S (minikube v1.1.1)

… che editors (#803) Signed-off-by: Sun Tan <[email protected]>

tsmaeder requested review from sunix, vitaliy-guliy and ericwill July 13, 2020 11:59

tsmaeder requested review from azatsarynnyy and benoitf as code owners July 13, 2020 11:59

sunix reviewed Jul 13, 2020

View reviewed changes

ericwill mentioned this pull request Jul 15, 2020

Plugins Sprint 187 eclipse-che/che#17418

Closed

38 tasks

ericwill added this to the 7.17 milestone Jul 15, 2020

ericwill reviewed Jul 15, 2020

View reviewed changes

ericwill approved these changes Jul 30, 2020

View reviewed changes

ericwill mentioned this pull request Jul 30, 2020

Plugins Sprint 188 eclipse-che/che#17532

Closed

29 tasks

tsmaeder force-pushed the 13249_describe_sidecar_debug branch from 0280358 to 9db092a Compare July 31, 2020 07:54

benoitf reviewed Jul 31, 2020

View reviewed changes

tsmaeder force-pushed the 13249_describe_sidecar_debug branch from 9db092a to 815bf09 Compare August 3, 2020 08:06

Describe running and debugging plugins in sidecars

c55bfb4

Signed-off-by: Thomas Mäder <[email protected]>

tsmaeder force-pushed the 13249_describe_sidecar_debug branch from 815bf09 to c55bfb4 Compare August 4, 2020 08:35

benoitf merged commit 5155d75 into eclipse-che:master Aug 4, 2020

l0rd added the new&noteworthy For new and/or noteworthy issues that deserve a blog post, new docs, or emphasis in release notes label Aug 11, 2020

vinokurig pushed a commit that referenced this pull request Apr 6, 2021

chore(devfile): More infos in the didact guide on how to add and edit…

a284fb2

… che editors (#803) Signed-off-by: Sun Tan <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Describe running and debugging plugins in sidecars #803

Describe running and debugging plugins in sidecars #803

tsmaeder commented Jul 13, 2020

che-bot commented Jul 13, 2020

sunix Jul 13, 2020

ericwill Jul 15, 2020

ericwill Jul 15, 2020

ericwill commented Jul 27, 2020

benoitf commented Jul 31, 2020

benoitf Jul 31, 2020 •

edited

Loading

benoitf Jul 31, 2020

benoitf Jul 31, 2020

tsmaeder Aug 4, 2020

che-bot commented Jul 31, 2020

che-bot commented Aug 3, 2020

tsmaeder commented Aug 4, 2020

benoitf commented Aug 4, 2020

che-bot commented Aug 4, 2020

che-bot commented Aug 4, 2020


		## Setting up plugins to run

		We can now add plugins to run in the sidecar container by adding them to the folder `/projects/plugins-1`(or whaterver we define as `THEIA_PLUGINS`env variable). If we're just interested in debugging the theia plugins host process, we can download a *.vsix file to the folder: it will be unpacked to a subfolder of `/tmp`. If we need to debug the plugin, we can checkout the source code and built it according the the instructions for the plugin:


		This way, the IDE and the remote plugin host process can find each other.

		The container in question must be able to work as a plugin sidecar for any plugin you want to run in it. If you are trying to debug a plugin that already has a sidecar container, it would make sense to base `remote-1`container on the sidecar that runs the original plugin. In that case, you would have to add a copy of node to sidecar container, since they generally don't contain one and we need to run the runtime host process, which is a node application. In this case, however, I've started with a `theia-dev`image and just point it to a JDK I've copied to `/projects/java-11-openjdk`by setting `JAVA_HOME`.


		The container in question must be able to work as a plugin sidecar for any plugin you want to run in it. If you are trying to debug a plugin that already has a sidecar container, it would make sense to base `remote-1`container on the sidecar that runs the original plugin. In that case, you would have to add a copy of node to sidecar container, since they generally don't contain one and we need to run the runtime host process, which is a node application. In this case, however, I've started with a `theia-dev`image and just point it to a JDK I've copied to `/projects/java-11-openjdk`by setting `JAVA_HOME`.

		If we want to debug later on, we'll have to add the `node-debug2`Che plugin to our workspace:

Describe running and debugging plugins in sidecars #803

Describe running and debugging plugins in sidecars #803

Conversation

tsmaeder commented Jul 13, 2020

What does this PR do?

What issues does this PR fix or reference?

che-bot commented Jul 13, 2020

sunix Jul 13, 2020

Choose a reason for hiding this comment

ericwill Jul 15, 2020

Choose a reason for hiding this comment

ericwill Jul 15, 2020

Choose a reason for hiding this comment

ericwill commented Jul 27, 2020

benoitf commented Jul 31, 2020

benoitf Jul 31, 2020 • edited Loading

Choose a reason for hiding this comment

benoitf Jul 31, 2020

Choose a reason for hiding this comment

benoitf Jul 31, 2020

Choose a reason for hiding this comment

tsmaeder Aug 4, 2020

Choose a reason for hiding this comment

che-bot commented Jul 31, 2020

che-bot commented Aug 3, 2020

tsmaeder commented Aug 4, 2020

benoitf commented Aug 4, 2020

che-bot commented Aug 4, 2020

che-bot commented Aug 4, 2020

benoitf Jul 31, 2020 •

edited

Loading