Dev Spaces Remote SSH Extension

Support for connecting a local VS Code instance, over SSH, to a Red Hat OpenShift Dev Spaces developer workspace (DevWorkspace).

This contributes remote host entries under the "SSH" category of the "Remote Explorer" view.

Prerequisites

• oc commandline tool (installed and on the user or system path)
• One of :
  • Remote - SSH (ms-vscode-remote.remote-ssh) provided by Microsoft for VS Code
  • Open Remote - SSH (jeanp413.open-remote-ssh) for a Code based editor

Usage

This extension uses the existing Remote support provided by either Remote - SSH or Open Remote - SSH to contribute Red Hat OpenShift Dev Spaces developer workspaces as SSH hosts, and automates eastablishing the connection.

When selecting Visual Studio Code (desktop) (SSH) editor, this establishes an SSHD service in the user's development container (as defined by their devfile). This editor also opens a landing webpage that contains instructions on how to connect to the workspace from a local VS Code-based editor. These instructions are not trivial, so this workflow simplifies the process by setting up the connection automatically.

The extension provides two main workflows for connecting to a remote developer workspace :

1. Using a developer workspace URL

With this workflow, simply providing the URL of the landing webpage of the developer workspace. The URL will often be of the form : https://${CLUSTER_URL}/${USER}/${DEVWORKSPACE_NAME}/3400/

From the "Remote Explorer" view, select one of the "Connect to Dev Spaces" icons within the view and provide the landing page URL of the developer workspace (DevWorkspace).

This will redirect to the corresponding cluster's login webpage. Once appropriate credentials have been entered, the existing VS Code instance will be connected to the remote developer workspace.

2. From the Remote Explorer view

If already logged into the cluster locally, a connection can be established in the current window, or a new one. Simply go into the "Remote Explorer" view and select a developer workspace under the "SSH" category.

Developing the extension

• Run npm install in terminal to install dependencies
• Run the Run Extension target in the Debug View. This will:
  • Start a task npm: watch to compile the code
  • Run the extension in a new VS Code window