software:vscode:caviness

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
Next revisionBoth sides next revision
software:vscode:caviness [2024-03-27 16:24] – anitasoftware:vscode:caviness [2024-04-25 14:05] – [Using SSH keys] anita
Line 1: Line 1:
 ====== Using VSCode Backend on Caviness====== ====== Using VSCode Backend on Caviness======
-<note warning> 
  
-**This page is under construction.** 
-</note> 
 ==== Download and install ==== ==== 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 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.
Line 10: Line 7:
  
 ==== Setting up remote connections ==== ==== 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. 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 located on the right side of the extension, and a drop-down menu will appear. Select ''Extension Settings'' from this menu.+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|}} {{:software:vscode:vscode-1.png?600|}}
  
-You will need to create a separate SSH Config file for the 'Remote - SSH' extension without modifying the regular SSH Config file. Throughout this guide, we use the name ''traine'' and the path ''~/vscode-remote-ssh/config'' for illustrative purposes only. You will need to use your user name on Caviness and absolute paths on your local machine to save the Config file. The ''Connect Timeout'' also needs to increase to 300 seconds in order to allow Slurm time to schedule and launch the interactive job. 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.+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.
  
-<note important> +To ensure the settings are correct, remove all existing lines in ''{} settings.json'' and replace them with these lines between the ''{'' ''}''
-To ensure the settings are correct, remove any existing lines in the ''json.settings'' and replace them with these+
 <code> <code>
     "remote.SSH.configFile": "~/vscode-remote-ssh/config",     "remote.SSH.configFile": "~/vscode-remote-ssh/config",
Line 25: Line 21:
     "remote.SSH.localServerDownload": "off",     "remote.SSH.localServerDownload": "off",
     "remote.SSH.lockfilesInTmp": true,     "remote.SSH.lockfilesInTmp": true,
 +    "remote.SSH.useLocalServer": true,
 +    "remote.SSH.useExecServer": false,
     "remote.SSH.enableRemoteCommand": true     "remote.SSH.enableRemoteCommand": true
 </code> </code>
-</note> +  
- +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.
-Again keep in mind ''~/vscode-remote-ssh/config'' is used for illustrative purposes or you can change this to specify the path and filename of choice.+
  
 <note important> <note important>
-The path of ''settings.json'' can be found at:+The path of ''{} settings.json'' can be found at:
                      
  
Line 41: Line 38:
 </note> </note>
  
-Now, close the ''Settings'' tab. 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''. +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-4.png?400|}}
Line 48: Line 45:
 {{:software:vscode:vscode-7.png?400|}} {{:software:vscode:vscode-7.png?400|}}
  
-It will open the Config file located in the path specified by ''~/vscode-remote-ssh/config'', and you can edit the Config file. You may have multiple configurations used on Caviness with different Host names. For example, in this Config file, ''Host Caviness'' starts the interactive job on the ''devel'' partition and requests 4 CPUs for the remote shell to use. '' Host CavinessGPU'' requests the GPU for the interactive job.+It will open the Config file located in the path specified by ''~/vscode-remote-ssh/config''. You may have multiple configurations used for Caviness with different Host definitions. For example, in this Config file, ''Host Caviness'' starts the interactive job on the ''devel'' partition and requests 4 CPUs for the remote shell to use. '' Host CavinessGPU'' requests a P100 GPU for the interactive job on the ''devel'' partition.
  
 +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> <code>
 # Read more about SSH config files: https://linux.die.net/man/5/ssh_config # Read more about SSH config files: https://linux.die.net/man/5/ssh_config
Line 71: Line 69:
  
 <note important> <note important>
-''vscode-shell-proxy'' does not work properly for MPI over multiple nodes on Caviness due to an older version of Slurm, please do not attempt to use multiple nodes like '-N 2'.  Instead, if you need to use VSCode for MPI over multiple nodes,  do NOT use ''vscode-shell-proxy'', and set the hostname to either   ''login00.caviness.hpc.udel.edu'' or ''login01.caviness.hpc.udel.edu''.+''vscode-shell-proxy'' does not work properly for MPI over multiple nodes on Caviness due to an older version of Slurm, please do not attempt to use multiple nodes like '-N 2'.  Instead, if you need to use VSCode for MPI over multiple nodes,  do NOT use ''vscode-shell-proxy'', and set the hostname to either ''login00.caviness.hpc.udel.edu'' or ''login01.caviness.hpc.udel.edu''.
 <code> <code>
 Host CavinessMPI Host CavinessMPI
Line 127: Line 125:
  
 ==== Using SSH keys ==== ==== Using SSH keys ====
-SSH public key authentication is a secure way to authenticate with an SSH host by combining a local "private" key with a "public" key associated with your user account. Once you set up the SSH keys, you will not need to enter the password for every login. Please only generate the SSH keys on the trusted computer. For macOS / Linux, you can run the following command in a local terminal:+SSH public key authentication is a secure way to authenticate with an SSH host by combining a local "private" key with a "public" key associated with your user account. Once you set up the SSH keys, you will not need to enter the password for every login. If you have previously set up your SSH keys (i.e. you can login with SSH to Caviness without having to enter your password), then you do not need to do this step. Proceed to [[https://docs.hpc.udel.edu/software/vscode/caviness#connect-vscode-to-compute-node]]. Please only generate the SSH keys on the trusted computer. For macOS / Linux, you can run the following command in a local terminal:
 <code> <code>
 ssh-keygen -t ed25519 -f ~/.ssh/id_ed25519-remote-ssh ssh-keygen -t ed25519 -f ~/.ssh/id_ed25519-remote-ssh
Line 136: Line 134:
 For Windows, run the following command in a local PowerShell as administrator: For Windows, run the following command in a local PowerShell as administrator:
 <code> <code>
-ssh-keygen -t ed25519 -f "$HOME\.ssh\id_ed25519-remote-ssh.pub"+ssh-keygen -t ed25519 -f "$HOME\.ssh\id_ed25519-remote-ssh"
 $USER_AT_HOST="your-user-name@caviness.hpc.udel.edu" $USER_AT_HOST="your-user-name@caviness.hpc.udel.edu"
 $PUBKEYPATH="$HOME\.ssh\id_ed25519-remote-ssh.pub" $PUBKEYPATH="$HOME\.ssh\id_ed25519-remote-ssh.pub"
  • software/vscode/caviness.txt
  • Last modified: 2024-04-26 17:34
  • by anita