Differences

This shows you the differences between two versions of the page.

--- software:vscode:darwin [2023-12-13 17:00] – [Setting up remote connections] thuachen
+++ software:vscode:darwin [2024-04-26 17:35] – [Using SSH keys] anita
@@ Line 1: / Line 1: @@
+====== Using VSCode Backend on DARWIN ======
+==== Download and install ====
+  - Install the [[http://code.visualstudio.com/download|Stable Build VSCode]] on the local machine. **DO NOT** install the VSCode Insiders Build, as it will not work with the proxy.
+  - Install a [[https://code.visualstudio.com/docs/remote/troubleshooting|supported SSH client]].
+  - In the extensions tab of VSCode, search for [[https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh|Remote - SSH]] and install.
+==== Setting up remote connections ====
+First, open VSCode on your computer. You'll see an icon on the left-hand side that looks like a square with some smaller squares inside it; this is the ''Extensions'' icon (labeled 1). Click on that icon to open the ''Extensions'' view. In the search bar at the top, type ''Remote - SSH'' and hit Enter. You'll see the ''Remote - SSH'' extension in the search results. Click on the gearwheel icon (labeled 2) located on the right side of the extension, and a drop-down menu will appear. Select ''Extension Settings'' from this menu.
+{{:software:vscode:vscode-1.png?600|}}
+The ''remote.SSH'' settings are written as a JSON dictionary and can be edited by clicking on the icon for ''Open Settings (JSON)'' located in the upper right corner below the title bar of the window (marked with large red arrow).This will open a the ''{} settings.json'' file and display each ''remote.SSH'' settings.  **Note:** You will need to create a separate SSH Config file for the 'Remote - SSH' extension without modifying the regular SSH Config file, referred to as ''~/vscode-remote-ssh/config'' below.
+To ensure the settings are correct, remove all existing lines in ''{} settings.json'' and replace them with these lines between the ''{'' ''}''
+<code>
+    "remote.SSH.configFile": "~/vscode-remote-ssh/config",
+    "remote.SSH.connectTimeout": 300,
+    "remote.SSH.defaultForwardedPorts": [],
+    "remote.SSH.maxReconnectionAttempts": 0,
+    "remote.SSH.localServerDownload": "off",
+    "remote.SSH.lockfilesInTmp": true,
+    "remote.SSH.useLocalServer": true,
+    "remote.SSH.useExecServer": false,
+    "remote.SSH.enableRemoteCommand": true
+</code>
+Clicking on the ''X'' next to ''{} settings.json'' will prompt you to save the settings file. Again keep in mind ''~/vscode-remote-ssh/config'' is used for illustrative purposes. You can change this to specify the path and filename of choice. The ''Connect Timeout'' is set to 300 seconds in order to allow Slurm enough time to schedule and launch the interactive job.
+<note important>
+The path of ''{} settings.json'' can be found at:
+^ Linux    |~/.config/Code/User/settings.json |
+^ Windows   | %APPDATA%\Code\User\settings.json     |
+^ Mac | ~/Library/Application\ Support/Code/User/settings.json|
+</note>
+Now, click on the ''X'' to close the ''Settings'' tab for the ''Remote - SSH Extensions Settings''. On the lower left corner, click the button ''Open a Remote Window''(or ''F1''), select ''Connect Current Window to Host'' and then ''Configure SSH Hosts''.
+{{:software:vscode:vscode-4.png?400|}}
+{{:software:vscode:vscode-5.png?400|}}
+{{:software:vscode:vscode-6.png?400|}}
+{{:software:vscode:vscode-7.png?400|}}
+It will open the Config file located in the path specified by ''~/vscode-remote-ssh/config''. You can have multiple configurations used for DARWIN with different Host definitions. For example, in the following Config file, ''Host DARWIN'' starts the interactive job on ''it_css'' partition and requests one CPU for the remote shell to use. ''Host DARWINGPU'' requests to use a GPU and ''Host DARWINMPI'' can be used for MPI.
+For this example,  the Config file ''~/vscode-remote-ssh/config'' contains the following definitions (remember User ''traine'' should be replace with your username as well as possible partition and other options)
+<code>
+# Read more about SSH config files: https://linux.die.net/man/5/ssh_config
+# Request CPU in idle partition
+Host DARWIN
+    HostName darwin.hpc.udel.edu
+    User traine
+    Forwardx11 no
+    ForwardX11Trusted no
+    RemoteCommand vscode-shell-proxy -g it_css --salloc-arg=--partition=idle --salloc-arg=--cpus-per-task=1 --salloc-arg=--time=01:00:00
+# Request GPU use
+Host DARWINGPU
+    HostName darwin.hpc.udel.edu
+    User traine
+    Forwardx11 no
+    ForwardX11Trusted no
+    RemoteCommand vscode-shell-proxy -g it_css --salloc-arg=--partition=idle --salloc-arg=--time=01:00:00 --salloc-arg=--gpus=1
+# For MPI code development
+Host DARWINMPI
+    HostName darwin.hpc.udel.edu
+    User traine
+    Forwardx11 no
+    ForwardX11Trusted no
+    RemoteCommand vscode-shell-proxy -g it_css --salloc-arg=--partition=idle --salloc-arg=--time=01:00:00 --salloc-arg=--cpus-per-task=1 --salloc-arg=--ntasks=8
+</code>
+The ''vscode-shell-proxy'' is the Python script executed on the login node to connect the interactive job.  A symbolic link ''vscode-shell-proxy'' was added to /usr/local/bin on the login nodes. The ''%%--%%help'' command show the usage of ''vscode-shell-proxy'':
+<code>
+usage: vscode-shell-proxy.py [-h] [-v] [-q] [-l <PATH>] [-0 <PATH>] [-1 <PATH>] [-2 <PATH>] [-b <N>] [-B <N>]
+                             [-H <HOSTNAME>] [-p <N>] [-g <WORKGROUP>] [-S <SLURM-ARG>]
+vscode remote shell proxy
+options:
+  -h, --help            show this help message and exit
+  -v, --verbose         increase the level of output as the program executes
+  -q, --quiet           decrease the level of output as the program executes
+  -l <PATH>, --log-file <PATH>
+                        direct all logging to this file rather than stderr; the token "[PID]" will be replaced with
+                        the running pid
+  -0 <PATH>, --tee-stdin <PATH>
+                        send a copy of input to the script stdin to this file; the token "[PID]" will be replaced with
+                        the running pid
+  -1 <PATH>, --tee-stdout <PATH>
+                        send a copy of output to the script stdout to this file; the token "[PID]" will be replaced
+                        with the running pid
+  -2 <PATH>, --tee-stderr <PATH>
+                        send a copy of output to the script stderr to this file; the token "[PID]" will be replaced
+                        with the running pid
+  -b <N>, --backlog <N>
+                        number of backlogged connections held by the proxy socket (see man page for listen(), default
+)
+  -B <N>, --byte-limit <N>
+                        maximum bytes read at one time per socket (default 4096
+  -H <HOSTNAME>, --listen-host <HOSTNAME>
+                        the client-facing TCP proxy should bind to this interface (default 127.0.0.1; use 0.0.0.0 for
+                        all interfaces)
+  -p <N>, --listen-port <N>
+                        the client-facing TCP proxy port (default 0 implies a random port is chosen)
+  -g <WORKGROUP>, --group <WORKGROUP>, --workgroup <WORKGROUP>
+                        the workgroup used to submit the vscode job
+  -S <SLURM-ARG>, --salloc-arg <SLURM-ARG>
+                        used zero or more times to specify arguments to the salloc command being wrapped (e.g.
+                        --partition=<name>, --ntasks=<N>)
+</code>
+<note important>
+Do not run the script ''vscode-shell-proxy'' itself on the login node, as it will start a remote interactive session.
+</note>
+==== Connect VSCode to compute node ====
+Now, we can connect the VSCode to the compute node. Follow the similar steps when adding the Config file from the [[:software:vscode:darwin#setting-up-remote-connections|Setting up Remote Connections]] except step 3. Since we created the host named "DARWIN", choose it and enter the credentials for DARWIN login (or [[software:vscode:darwin#using-ssh-keys| use SSH keys]]).
+{{:software:vscode:vscode-4.png?400|}}
+{{:software:vscode:vscode-5.png?400|}}
+{{:software:vscode:vscode-10.png?400|}}
+After successful login, you will now connect to the compute node. You can use the bash shell as the SSH terminal or develop code in VSCode.
+<code>
+[(it_css:traine)@r1n00 ~]$ hostname
+r1n00
+</code>
+You also can open the file on your home directory in ''DARWIN'' and edit it. After completing the job, click ''Close Remote Connection'' to stop the job.
+{{:software:vscode:vscode-9.png?400|}}