|
| 1 | +# VS Code Tunnel |
| 2 | + |
| 3 | +Please keep in mind, that this is not a VS Code manual, |
| 4 | +it is only our recommendation how to connect to the {{ hpcinfra }} using the VS code tunnel. |
| 5 | + |
| 6 | +For VS Code documentation, see <https://code.visualstudio.com/docs> |
| 7 | + |
| 8 | +We only support VS Code tunnel access via the VS Code application (installed locally), |
| 9 | +since web access might not work from all browser or operational system. |
| 10 | +The only confirmed way to connect via a browser is using Windows 11 and Edge. |
| 11 | + |
| 12 | +## Prerequisites |
| 13 | + |
| 14 | +We do recommend to install remote developent for the VS Code App. |
| 15 | + |
| 16 | + |
| 17 | +## Connection |
| 18 | + |
| 19 | +In the [web portal](./web_portal.md), under the "Interactive Apps" choose VS Code Tunnel, |
| 20 | +select the parameters and launch your job by clicking ++Launch"++ |
| 21 | +When your job has started, connect by clicking ++"Connect"++ |
| 22 | + |
| 23 | +In the new browser tab or window, for the question |
| 24 | +`How would you like to log in to Visual Studio Code?` choose `Microsoft Account` |
| 25 | +(using the arrow keys on your keyboard, then hit ++"Enter"++). |
| 26 | +Then follow the instruction to authenticate yourself. |
| 27 | +If you get an error message something like "You do not have access to this" |
| 28 | +durng the Microsoft Authentication, then you might have to |
| 29 | +[whitelist yourself](https://dictselfservice.ugent.be/index.php?page=requestform&form=deviceCodeAuth) |
| 30 | +(You have to do it only once.) |
| 31 | + |
| 32 | +If you are not connected automatically to the tunnel, please select "connect to..." and then |
| 33 | +"Connet to Tunnel" using Microsoft Account and select the tunnel named `vsc-<your vsc account>-<cluster>`. |
| 34 | +Please note that right now you can only have one tunnel per cluster. |
| 35 | + |
| 36 | +If you are asked to update VS Code CLI on your remote server, choose ++"Not Now"++. |
| 37 | +You do not have permission to update the CLI, as it is centrally installed. |
| 38 | +This means that your VS Code App is newer than the CLI on our systems. |
| 39 | +We update the centrally installed CLI time to time, |
| 40 | +but the upgrade rate of the App/CLI is very high, |
| 41 | +so it is hard for us to follow it tightly. |
| 42 | + |
| 43 | +Please do not use VS Code to ssh to the login nodes, |
| 44 | +but always use a VS Code Tunnel conection, |
| 45 | +peferably using the [interactive and debug cluster](./interactive_debug.md) |
| 46 | + |
0 commit comments