OpenShift Dev Spaces Gateway Plugin

Plugin for JetBrains Gateway enables local desktop development experience with the IntelliJ IDEs connected to OpenShift Dev Spaces.

Usage

The plugin adds a Dev Spaces connector to the JetBrains Gateway.

1. Open the Gateway and select the Dev Spaces connector.
2. Enter the Dev Spaces server URL and authenticate (Token, OpenShift OAuth, client certificate, or username/password).
3. Select a running DevWorkspace and connect.

The IDE runs on the local desktop while the workspace IDE server connects over a port-forwarded tunnel.

A jetbrains-gateway://connect link with the workspace's dwNamespace and dwName parameters connects directly, skipping the wizard:

jetbrains-gateway://connect#type=devspaces&dwNamespace=john-che&dwName=my-ws

Feedback

We love to hear from users and developers.

You can ask questions, report bugs, and request features using GitHub issues in the Eclipse Che main repository.

Development

• To test the plugin quickly against the Gateway instance bundled with the plugin, run:

./gradlew runIde

• To skip opening the Gateway main window and connect to an already running workspace with the IDEA dev server:

./gradlew runIde --args="jetbrains-gateway://connect#type=devspaces&dwNamespace=john-che&dwName=my-ws"

with replacing your DevWorkspace's namespace and name in dwNamespace and dwName parameters.

Building

1. Run:

./gradlew clean buildPlugin

2. Find the built plugin in the build/distributions folder.

Installation

In the Gateway, click the gear button ⚙️, and choose Manage Providers to open the Plugins window.

There're a couple of options to install the plugin:

• Search for "OpenShift Dev Spaces".
• Click the gear button ⚙️ and choose Install Plugin from Disk.... Then,
  • choose the built plugin (zip) located at the build/distributions folder, or
  • download the plugin from the latest release

IntelliJ Plugin Verifier

To check the plugin compatibility against the Gateway versions defined in the gradle.properties file.

./gradlew runPluginVerifier

Troubleshooting

1. To check the state of the port forwarding:

sudo lsof -i -P | grep LISTEN | grep 5990

2. The Gateway application and the Dev Spaces plugin logs are stored in /Users/<USER_NAME>/Library/Logs/JetBrains/JetBrainsGateway<VERSION>/idea.log

3. Port-forward transport (Java WebSocket):

   • On connect, logs should include: Starting port forward on local port … (transport=java-websocket, copyBuffer=65536, dispatcher=devspaces-port-forward)
   • If the UI feels sluggish or you see “IntelliJ IDEA has encountered a slowdown”, collect:
     • Gateway/IDEA logs (…/Library/Logs/JetBrains/JetBrainsGateway*/idea.log or IDEA equivalent)
     • Any PerformanceWatcherImpl / Dispatchers.IO / thread-dump lines
     • Whether the banner appears during idle editing vs only while Analyzing...

Release

• Find a draft release on the Releases page. The draft is created and updated automatically on each push to the main branch.
• Edit the draft:
  • Click the Generate release notes button and edit the release notes if needed
  • Click the Publish release button. The Release Workflow will attach the built plugin artifact to the published release.
• Upload the plugin artifact to JetBrains Marketplace.
• Find the Changelog update - v0.0.x PR, created automatically by the Release Workflow, and merge it. Note that currently, it requires closing and reopening the PR to trigger the PR checks. As, due to some issue, they are hanging in a waiting state forever.
• Bump the pluginVersion in the gradle.properties file.

---

Plugin based on the IntelliJ Platform Plugin Template.