Add devfile and doc for developing of Che Theia remote plugin mechanism

Signed-off-by: Mykola Morhun <[email protected]>

Author: mmorhun

extensions/eclipse-che-theia-plugin-remote/README.md

@@ -0,0 +1,21 @@
+
+### How to develop Che Theia remote plugin mechanism
+
+_Please note, this doc provides a flow how to develop remote plugin mechanism in Che Theia, but not a remoute plugin._
+
+First, create a workspace from prepared devfile, which could be found in the extension folder.
+When workspace is ready:
+ - Init Che Theia. This could be done with `che:theia init` command in `/projects/theia` folder or run the init command.
+   Che Theia sources will be awailable at `/projects/theia/che/che-theia`.
+ - Now one may make changes in Che Theia remote plugin mechanism in both (Che Theia and Remote plugin) sides.
+ - Build Che Theia from `theia-dev` container by executing `yarn` in `/projects/theia` folder or by running corresponding command.
+ - Put your remote plugin(s) into `/projects/remote-plugins/` dorectory.
+   Note that the plugins shouldn't have any external dependencies.
+ - Run dev Che Theia and Remote plugins endpoint in `theia-dev` and `theia-remote-runtime-dev` containers correspondingly.
+   One may use predefined commands to start them.
+ - Open `theia-dev` route from `My Workspace` panel and test chenges.
+
+Also it is possible to run watchers for remote plugin mechanism.
+In `theia-dev` container run `npx run watch @eclipse-che/theia-remote` from `/projects/theia` folder to recompile the extension on changes made.
+Also run `yarn watch` in `/projects/theia/examples/assembly` to bring the changes to Che Theia binaries.
+The command for this is also available.

extensions/eclipse-che-theia-plugin-remote/devfile.yaml

@@ -0,0 +1,80 @@
+apiVersion: 1.0.0
+metadata:
+  name: che-theia-remote-dev
+projects:
+  - name: theia
+    source:
+      type: git
+      location: 'https://github.com/theia-ide/theia.git'
+components:
+  - type: cheEditor
+    id: eclipse/che-theia/next
+    alias: theia-editor
+  - type: chePlugin
+    id: eclipse/che-machine-exec-plugin/next
+  - type: chePlugin
+    id: che-incubator/typescript/latest
+  - type: dockerimage
+    image: eclipse/che-theia-dev:next
+    alias: theia-dev
+    mountSources: true
+    env:
+      - name: THEIA_PLUGIN_ENDPOINT_DISCOVERY_PORT
+        value: '2504'
+    memoryLimit: 3Gi
+  - type: dockerimage
+    image: eclipse/che-theia-dev:next
+    alias: theia-remote-runtime-dev
+    mountSources: true
+    env:
+      - name: THEIA_PLUGIN_ENDPOINT_DISCOVERY_PORT
+        value: '2504'
+      - name: THEIA_PLUGINS
+        value: 'local-dir:///projects/remote-plugins/'
+    memoryLimit: 1Gi
+commands:
+  - name: Init Che Theia
+    actions:
+      - type: exec
+        component: theia-dev
+        command: che:theia init
+        workdir: /projects/theia
+  - name: Clean Che Theia
+    actions:
+      - type: exec
+        component: theia-dev
+        command: che:theia clean
+        workdir: /projects/theia
+  - name: Build Che Theia
+    actions:
+      - type: exec
+        component: theia-dev
+        command: yarn
+        workdir: /projects/theia
+  - name: Watch changes in Theia Remote Extension
+    actions:
+      - type: exec
+        component: theia-dev
+        command: 'cd /projects/theia && npx run watch @eclipse-che/theia-remote & cd /projects/theia/examples/assembly && yarn watch'
+  - name: Run Dev Theia
+    actions:
+      - type: exec
+        component: theia-dev
+        command: 'yarn theia start --hostname=0.0.0.0 --port=3130'
+        workdir: /projects/theia/examples/assembly
+  - name: Run Remote Theia Plugin Endpoint
+    actions:
+      - type: exec
+        component: theia-remote-runtime-dev
+        command: 'node plugin-remote.js'
+        workdir: /projects/theia/che/che-theia/extensions/eclipse-che-theia-plugin-remote/lib/node
+  - name: Terminate all in Dev Theia
+    actions:
+      - type: exec
+        component: theia-dev
+        command: 'killall node'
+  - name: Terminate all in Remote Theia Plugin Endpoint
+    actions:
+      - type: exec
+        component: theia-remote-runtime-dev
+        command: 'killall node'