Skip to content

Commit

Permalink
add VS Code Tunnel recommendations
Browse files Browse the repository at this point in the history
  • Loading branch information
hajgato committed Oct 4, 2024
1 parent e24f8f9 commit 587b9fe
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 0 deletions.
1 change: 1 addition & 0 deletions config/templates/hpc.template
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ nav:
- OpenFOAM: openFOAM.md
- Python: python.md
- Python virtual environments: setting_up_python_virtual_environments.md
- VS Code Tunnel: VScode.md
- FAQ:
- Frequently Asked Questions: FAQ.md
- Appendices:
Expand Down
46 changes: 46 additions & 0 deletions mkdocs/docs/HPC/VScode.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# VS Code Tunnel

Please keep in mind, that this is not a VS Code manual,
it is only our recommendation how to connect to the {{ hpcinfra }} using the VS code tunnel.

For VS Code documentation, see <https://code.visualstudio.com/docs>

We only support VS Code tunnel access via the VS Code application (installed locally),
since web access might not work from all browser or operational system.
The only confirmed way to connect via a browser is using Windows 11 and Edge.

## Prerequisites

We do recommend to install remote developent for the VS Code App.


## Connection

In the [web portal](./web_portal.md), under the "Interactive Apps" choose VS Code Tunnel,
select the parameters and launch your job by clicking ++Launch"++
When your job has started, connect by clicking ++"Connect"++

In the new browser tab or window, for the question
`How would you like to log in to Visual Studio Code?` choose `Microsoft Account`
(using the arrow keys on your keyboard, then hit ++"Enter"++).
Then follow the instruction to authenticate yourself.
If you get an error message something like "You do not have access to this"
durng the Microsoft Authentication, then you might have to
[whitelist yourself](https://dictselfservice.ugent.be/index.php?page=requestform&form=deviceCodeAuth)
(You have to do it only once.)

If you are not connected automatically to the tunnel, please select "connect to..." and then
"Connet to Tunnel" using Microsoft Account and select the tunnel named `vsc-<your vsc account>-<cluster>`.
Please note that right now you can only have one tunnel per cluster.

If you are asked to update VS Code CLI on your remote server, choose ++"Not Now"++.
You do not have permission to update the CLI, as it is centrally installed.
This means that your VS Code App is newer than the CLI on our systems.
We update the centrally installed CLI time to time,
but the upgrade rate of the App/CLI is very high,
so it is hard for us to follow it tightly.

Please do not use VS Code to ssh to the login nodes,
but always use a VS Code Tunnel conection,
peferably using the [interactive and debug cluster](./interactive_debug.md)

0 comments on commit 587b9fe

Please sign in to comment.