EclipseCon Europe Workshop

[l0rd]

Epic Description

Goal Enable the self-hosting experience for any Che user and inspire users to build and share new Che plugins

Story As a plugin contributor, I want to create a plugin (server + ui) on che.openshift.io and add it to the plugin registry so that I can showcase it

Example use cases:

• Integrate a new LS
• Integrate a code prettifier

Success Criteria

• Plugin Authoring Workshop has been run both internally and externally using che.openshift.io
• Plugin Authoring Getting Started Documentation is available on eclipse che documentation web site (not for che.openshift.io only)
• Che website part on how to extend Che has been updated
• Contribution guidelines are in the che-plugin-registry repository
• There are a few Plugin Samples with corresponding factories for che.openshift.io (a language server, a code prettifier)
• Plugin Scaffolding (tool to generate a che plugin repository template)
• When creating a workspace I can choose the plugins to add to it
• BONUS: Plan B to run a workshop if che.openshift.io is not available (internet is down)
• BONUS: An Editor swapping example (with Jupyter for example demo and blog post should be enough)

What’s in EclipseCon Europe milestone Easy self-hosting environment setup (for che and theia plugin authoring using che) on che.openshift.io

What’s not in EclipseCon Europe milestone Using a plugin marketplace to publish, search plugins for Che workspaces, the deployment of a public plugin registry to use from any Che instance

Target 23 October

Prerequisite and Architectural details #10123

Epic Subtasks

For EclipseCon EU

• Plugin registry should have validation of meta file path (alligned with id, version from meta.yaml) Plugin registry build process should ensure that meta.yaml content is aligned with its location  #10839
• Add PR check for che-plugin-registry to prevent merging invalid meta.yaml files Add PR check for che-plugin-registry to prevent merging invalid meta.yaml files #10844
• Add PR check for che-plugin-registry to prevent merging invalid meta.yaml files Add PR check for che-plugin-registry to prevent merging invalid meta.yaml files #10844
• Plugin registry build process should ensure that meta.yaml content is aligned with its location Plugin registry build process should ensure that meta.yaml content is aligned with its location  #10839
• Factory feature doesn't support Workspace.Next Factory and stack features are not supported in Workspace.Next #10368
• Add type of the object to the index file of che-plugin-registry Add type of the object to the index file of che-plugin-registry #10781
• Plugin registry should have a description how to get a list of plugins, how to get meta.yaml of a plugin from this list Create README.md to eclipse/che-plugin-registry #10834
• Add a Plugin Registry API to retrieve the list of plugins Add a "Plugin Registry API" to retrieve the list of plugins #10745
• Add websocket reconnection feature to workspace loader app Add websocket reconnection feature to workspace loader app #10365

OSIO team

• Add che-plugin-registry route on OSIO to be able to use it from UD Expose che-plugin-registry publicly to allow access from Che UD redhat-developer/rh-che#807
• Add memory limit for ChePlugin container Add memory limit concept to container of Workspace.Next ChePlugin #10272
• Registry doesn't support plugins with several versions Registry doesn't support plugins with several versions  che-plugin-registry#31
• Make Workspace.Next work with Dockerimage recipe type Make Workspace.Next work with Dockerimage recipe type #9871
• Allow to customize Broker image and pull strategy for the development purposes
• Add memory limits configuration into walking skeleton flow Add memory limits configuration into walking skeleton flow #11097
• Cleanup plugins on Che Plugin Broker start to avoid usage of Theia plugins that were removed from workspace Cleanup plugins on Che Plugin Broker start to avoid usage of Theia plugins that were removed from workspace #11095
• Do not allow the start of a workspace that has both installers and WS.NEXT plugins Do not allow the start of a workspace that has both installers and WS.NEXT plugins #11259
• Allow to use JWT-proxy based Che workspace security for a particular user/workspace Allow to use JWT-proxy based Che workspace security for a particular user/workspace redhat-developer/rh-che#853
• How to avoid issues with k8s service number limit in WS.NEXT How to avoid issues with k8s service number limit in WS.NEXT redhat-developer/rh-che#934
• Check if plugin-registry is configured when starting workspace with plugins [ws.next] Workspace engine should throw error if plugins are required but plug-in registry is not there #11124
• An Editor swapping example ( with Jupyter for example demo and blog post should be enough) An Editor swapping example ( with Jupyter for example demo and blog post should be enough) #11383
• Set memory request for sidecars and broker Set sidecar and broker memory request #11382
• Check exec/terminal on OSIO Check that exec/terminal sidecar in WS.NEXT works on OSIO redhat-developer/rh-che#933
• Fix memory request for jwtproxy sidecar Error to create jwtproxy sidecar on OSIO #11547

PLATFORM team

• Cover plugin broker service methods with authorization checks Cover plugin broker service methods with authorization checks #11080
• Plugin Broker doesn't work on multi-user Che Plugin Broker doesn't work on multi-user Che #11071
• Add public link for che-plugin-registry Add public link for che-plugin-registry #10918
• Add plugin's description to plugins list response Add plugin's description to plugins list response #11055
• Set sidecar container name from sidecar definition Set sidecar container name from sidecar definition #11096
• Prevent caching of index file by browser Prevent caching of index file by browser che-plugin-registry#30
• Plugin Broker does not respect pod status Plugin Broker does not respect pod status #11070
• Provide an access token for terminal and exec sidecar Provide an access token for terminal and exec sidecar #10991
• Workspace.Next: Errors of broker pod are not propagated to a client Workspace.Next: Errors of broker pod are not propagated to a client #11068
• Workspace.Next: Propagate logs from broker pod to ws-master Workspace.Next: Propagate broker pod logs to a client #11069
• Walking skeleton tooling in a workspace uses different pulling strategies for different containers Walking skeleton pulling strategies #11017
• Configure broker timeout in Che Configure broker timeout in Che #11120
• Container tooling naming Improve naming for wsnext tooling containers #11031
• An Editor swapping example ( with Jupyter for example demo and blog post should be enough) An Editor swapping example ( with Jupyter for example demo and blog post should be enough) #11383
• Setup default plugin registry url Setup default plugin registry url #11352
• Provide the possibility to specify the plugin registry at the plugin definition level Add an ability to use a custom registry for WS.NEXT plugins #11265
• Define plugin testing process Define plugin testing process #11555
• Add an ability to disable discover-ability of a plugin endpoint Add an ability to disable discover-ability of a plugin endpoint #11606
• Add an ability to use a custom registry for WS.NEXT plugins Add an ability to use a custom registry for WS.NEXT plugins #11265
• Add an ability to disable discover-ability of a plugin endpoint Add an ability to disable discover-ability of a plugin endpoint #11606

IDE2 team

• Add Dashboard widget to select the plugins when editing a workspace form Add Dashboard widget to select the plugins #10780
• Avoid that an active workspace get killed after 15 minutes on osio Che + theia: Theia IDE do not send any activity events to wsmaster #11267
• Add Dashboard widget to select the plugins when creating a workspace form Add Dashboard widget to select the plugins #10780
• Ask a user to remove installers from a workspace when they enables WS.NEXT editor or plugin Ask a user to remove installer from a workspace when they enables WS.NEXT editor or plugin #11401
• Che Theia image doesn't have syntax hilighting for most languages (only typescript). We probably miss textmate extensions..

Florent

• Access the Theia Plugin API from a remote container
• Java, Typescript and nodejs debug support (as Theia extensions embedded in the Che Theia image)
• Fix yeoman first time question (submit or not statistics)
• Fix git
• Cleanup env variables required for remote containers/ theia plugin broker after chat with Oleksandr --> https://github.com/ws-skeleton/che-theia-remote-extension/commit/b7e6b40b78f3313b7bd9a680749169c8236cf213

Mario

• Work with QE to add 2 tests for the Walking Skeleton scenarios Create selenium tests for the walking skeleton flow #11047
• Workshop script for plan A (everything on openshift.io) - Draft
• Replace the 2 walking skelethon stacks with a Che 7 preview stack Create a Che 7 preview stack and remove the Workspace.next one #11502

Timeline

10th August: Friday Demos
17th August: Friday Demos
21st August (Sprint Review): Walking Skeleton demos (not OSIO) at Sprint Review
24th August: Friday Demos
31th August: Friday Demos
7 September: Friday Demos
10 September (Sprint Review): Walking Skeleton demos on OSIO at Sprint Review
14 September: Friday Demos
21 September: Friday Demos
28 September: Friday Demos
2 October (Sprint Review): Terminal+Task plugins and Factories running on OSIO
3 October: Start of K Train
5 October: Friday Demos + Preview Workshop (walking skeleton team)
12 October: Friday Demos + First draft of the Documentation/Getting Started/Website/Repo Updated
19 October: Friday Demos + Internal Workshop (rh dev tools)
22 October: Che community event (workshop)
23 October: Conference starts
25 October: Conference ends

[garagatyi]

Added Add public link for che-plugin-registry #10918 to the tasks list

[garagatyi]

I've rearranged tasks, marked some as finished, added splitting tasks by teams. There are plenty of tasks not moved to a specific team - we will need to triage them.
I also think that we might want to move a couple of tasks from After EclipseCon EU to For EclipseCon EU section:

• Add memory limit for ChePlugin container Add memory limit concept to container of Workspace.Next ChePlugin #10272 : without this tasks a workspace with Theia + user's image + service plugin sidecar takes 3GB of RAM which is way too much. It might also affect us to add more sidecar toolings into a workspace.
• Allow consuming LS functionality running as a sidecar in Theia base ide Allow consuming LS functionality running as a sidecar in Theia base ide #9441 : seems as a prerequisite for this task Java and Typescript LS packaged as Che plugins which is included into For EclipseCon EU section

[dneary]

I would like to add a few more topics that we need to get done - I do not have permissions to edit the ticket.

1. We will have 2 Chromebooks on the Che stand, with wired internet, to do demos and to show Che. We can give these Chromebooks away at the end of the week, and I would like to have a challenge - have people complete a small coding challenge on che.openshift.io to enter a draw, and then Thursday we do the draw to give them away.

• Define the challenge to be done
• Create a Factory link to get people started
• Something printed for the desk about the challenge and giveaway

2. "Walking Skeleton" blog post and/or tutorial - we need to make sure that we have some content on the website that supports the workshop on the walking skeleton

@eivantsov The first two items in #1 were the things I need your help with. My thinking is that we could do something like a Java, Python, and Javascript factory with (say) a list of numbers, and a requirement to print the numbers in order (very simple - the goal is sign-ups and get them with hands on code) with the language of their choice. What do you think?

[skabashnyuk]

added to the list of the Platform team tasks

• Define plugin testing process Define plugin testing process #11555
• Add an ability to use a custom registry for WS.NEXT plugins Add an ability to use a custom registry for WS.NEXT plugins #11265

[garagatyi]

@skabashnyuk I added an entry:
Meta files must contain field type for Che to be able to recognize what broker to use with it eclipse-che/che-plugin-registry#41
Would your team be able to pick it up ASAP?

As far as I understand your team will also address: Add an ability to disable discover-ability of a plugin endpoint #11606
Am I correct? (I added an explanation for to make it an easyfix)

[skabashnyuk]

Meta files must contain field type for Che to be able to recognize what broker to use with it >eclipse-che/che-plugin-registry#41
Would your team be able to pick it up ASAP?

Commented in issue. Please take a look. eclipse-che/che-plugin-registry#41 (comment)

[l0rd]

EclipseCon is over and we have been able to run some Che 7 demos and workspaces.

I am closing this issue and providing here is a list of tasks that were not flagged as completed:

osio team

• Theia Plugin Broker (to simplify the packaging of a Che plugin that contains only a Theia plugin) Theia Plugin Broker #11146
• Che plugin broker should support ephemeral mode Che plugin broker should support ephemeral mode #11554

ide2

• Factory in Theia doesn't clone project on OSIO Factory in Theia doesn't clone project on OSIO #11144

• Factory for self hosting with theia editor and necessary plugins on osio As a che.openshift.io user I want to have a possibility to try workspace.next with Theia IDE  openshiftio/openshift.io#3883

• Terminal and Task theia extensions

  • Kubernetes and OpenShift support
  • Package them as default theia extensions in Che Theia image
  • Implement them as Theia plugin rather than extensions

• Create some Che plugin and Theia plugin Examples (around 4 examples, Formatter for yaml, Java Formatter (based on Google coding style guide)) JS + CSS formatter, Editor API sample plugin

language team

• Add all Theia Plugin API for LSP support [plug-in] Languages API eclipse-theia/theia#2341
• Package jdt.ls as a Che plugin and publish it to the github.com/eclipse/che-plugin-registry
• Package Typescript LS as a Che plugin and publish it in github.com/eclipse/che-plugin-registry
• Theia Plugin Debugger API
• Java, Typescript and nodejs debug support

florent

• Plugin scaffolding (tool to generate a Che plugin source code structure template)

mario

• Find a way to build a Che plugin docker image from within a kube/openshift pod PoC
• Find out the minimum memory requirements to run a Che 7 workspace Find out the minimum memory requirements to run a Che 7 workspace #11499
• Test ws.next + Theia + plugin registry on Kubernetes and provide documentation
• Workshop script for plan B (if openshift.io is not available and internet is down)
• Create an Online Tutorial on eclipse.org/che/docs

misc

• Create a Theia Plugin that is responsible for Theia-Che communication:
  • Update workspace configuration (e.g. new added plugin)
  • Start a new Che plugin etc...
• Provide a “Restart Required” message to the user in the case the workspace containers need to be restarted:
  • A new Theia image is available
  • A Che plugin is added/updated to a running workspace (and all the ws containers run in the same pod)
• We track servers with specific names and show status in the API. We should reconsider this approach to be able to adopt other IDEs and not fail workspace when some server appears to have the same name as a hardcoded one but has different API
• Allow consuming LS functionality running as a sidecar in Theia base ide Allow consuming LS functionality running as a sidecar in Theia base ide #9441
• Add health checks for ChePlugin container Add an ability to configure health checks for container in Workpsace.Next ChePlugin #10273
• Commands API for Workspace.Next Commands API for Workspace.Next #9546
• Integrate che-plugin-registry deployment with the deployments of Che on k8s/OS Integrate che-plugin-registry deployment with the deployments of Che on k8s #10842
• Design and implement the flow to update a Theia plugin
• Theia plugins should be persisted so that a workspace will continue to load them even after a restart
• Multiple users downloading the same plugins at the same time
• Docker Infrastructure support
• Fix workspace tooling serialization technique Use DTO field name custom serialization in che-plugin-broker event #10880
• Validate infrastructure for endpoints Avoid the need to set userland-proxy #11018
• Meta files must contain field type for Che to be able to recognize what broker to use with it Meta files must contain field type for Che to be able to recognize what broker to use with it che-plugin-registry#41
• Allow running Che 7 Workspace with development tooling but without recipe Allow running Che 7 Workspace with development tooling but without recipe #11690
• Workspace attributes should use plugin IDs rather than plugin name Workspace attributes should use plugin IDs rather than plugin name #11600
• BONUS: Link plugin commands and Theia tasks
• Warning when starting the Che Plugin Broker Warning when starting the Che Plugin Broker #11662