| Both sides previous revision Previous revision Next revision | Previous revision |
| software:vscode:caviness [2024-08-19 14:21] – [Connect VSCode to Compute Node] bdeng | software:vscode:caviness [2025-03-13 16:29] (current) – [Setting up remote connections] anita |
|---|
| |
| ==== 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. If the version of VSCode downloaded is newer than version 1.90, please make sure to do these [[software:vscode:caviness#additional-steps-required-for-vscode-newer-than-version-190|additional steps]]. |
| - Install a [[https://code.visualstudio.com/docs/remote/troubleshooting|supported SSH client]]. | - 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. | - In the extensions tab of VSCode, search for [[https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-ssh|Remote - SSH]] and install. |
| {{: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''. 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. | 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 using ''it_css'' workgroup 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) | 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) |
| {{:software:vscode:vscode-9.png?400|}} | {{:software:vscode:vscode-9.png?400|}} |
| |
| <note important> | ==== Additional Steps required for VSCode newer than version 1.90 ==== |
| |
| | Recent releases of VSCode require a newer version of ''wget'' than the system's default version on Caviness. This discrepancy can result in a "connection failed" error as reported and discussed [[https://groups.google.com/a/udel.edu/g/hpc-ask/c/l8jvUHk2bUE/m/mAzWz7k5AAAJ|here]]. To resolve this, wget v1.24.5 has been installed at ''/opt/shared/wget/bin/wget''. |
| |
| Additional Steps for VSCode Newer Than 1.90 | <note important> |
| | |
| | |
| Recent releases of VSCode require a newer version of wget than the system's default version on Caviness. This discrepancy can result in a "connection failed" error, like discussed [[https://groups.google.com/a/udel.edu/g/hpc-ask/c/l8jvUHk2bUE/m/mAzWz7k5AAAJ|here]]. To resolve this, wget v1.24.5 has been installed at ''/opt/shared/wget/bin/wget''. | |
| |
| To ensure the updated version of wget is used by default, you can create a symbolic link in your ''~/bin'' directory by following the steps below: | To ensure the updated version of wget is used by default, you can create a symbolic link in your ''~/bin'' directory by following the steps below: |
| |
| |
| 2. Create a symbolic link of wget v1.24.5 in the ''~/bin'' directory: | 2. Create a symbolic link for wget v1.24.5 in the ''~/bin'' directory: |
| <code>ln -s /opt/shared/wget/1.24.5/bin/wget ~/bin/wget</code> | <code>ln -s /opt/shared/wget/1.24.5/bin/wget ~/bin/wget</code> |
| |
| 3. Modify your ''~/.bash_profile'' on Caviness: | 3. Modify your ''~/.bash_profile'' on Caviness: |
| | |
| Update the PATH variable by changing the line from: | Update the PATH variable by changing the line from: |
| <code>PATH=$PATH:$HOME/.local/bin:$HOME/bin</code> | <code>PATH=$PATH:$HOME/.local/bin:$HOME/bin</code> |
| <code>PATH=$HOME/.local/bin:$HOME/bin:$PATH</code> | <code>PATH=$HOME/.local/bin:$HOME/bin:$PATH</code> |
| |
| 4. Apply the changes to your ~/.bash_profile: | 4. Apply the changes to your ''~/.bash_profile'': |
| After making the changes, you can apply them by either logging out and back in or by running: | After making the changes, you can apply them by either logging out and back in or by running: |
| <code>source ~/.bash_profile</code> | <code>source ~/.bash_profile</code> |