Use Visual Studio Code with a Run:ai Job¶

Once you launch a workload using Run:ai, you will want to connect to it. You can do so via command line or via other tools such as a Jupyter Notebook

Important

This document is about accessing the remote container created by Run:ai, from the installed version of Visual Studio Code. If you want to use Visual Studio Code for web, please see Visual Studio Code Web Quickstart.

Submit a Workload¶

You will need your image to run an SSH server (e.g OpenSSH). For this document, we have created an image named runai.jfrog.io/demo/pycharm-demo. The image runs both python and ssh. Details on how to create the image are here. The image is configured to use the root user and password for SSH.

Run the following command to connect to the container as if it were running locally:

runai submit build-remote -i runai.jfrog.io/demo/pycharm-demo --interactive  \
        --service-type=portforward --port 2222:22

The terminal will show the connection:

The job 'build-remote' has been submitted successfully
You can run `runai describe job build-remote -p team-a` to check the job status
INFO[0007] Waiting for job to start
Waiting for job to start
Waiting for job to start
Waiting for job to start
INFO[0045] Job started
Open access point(s) to service from localhost:2222
Forwarding from [::1]:2222 -> 22

The Job starts an sshd server on port 22.
The connection is redirected to the local machine (127.0.0.1) on port 2222

Note

It is possible to connect to the container using a remote IP address. However, this would be less convinient as you will need to maintain port numbers manually and change them when remote accessing using the development tool. As an example, run:

runai submit build-remote -i runai.jfrog.io/demo/pycharm-demo -g 1 --interactive --service-type=nodeport --port 30022:22

The Job starts an sshd server on port 22.
The Job redirects the external port 30022 to port 22 and uses a Node Port service type.
Run: runai list jobs
Next to the Job, under the "Service URL" column you will find the IP address and port. The port is 30222

Visual Studio Code¶

Under Visual Studio code install the Remote SSH extension.
Create an ssh entry to the service by editing .ssh/config file or use the command Remote-SSH: Connect to Host... from the Command Palette. Enter the IP address and port from above (e.g. ssh root@35.34.212.12 -p 30022 or ssh root@127.0.0.1 -p 2222). User and password are root
Using VS Code, install the Python extension on the remote machine
Write your first Python code and run it remotely.