From 587b9fe8f5290a1ebaca1a1f0f26fb5beae011d2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bal=C3=A1zs=20Hajgat=C3=B3?= Date: Fri, 4 Oct 2024 12:22:02 +0200 Subject: [PATCH] add VS Code Tunnel recommendations --- config/templates/hpc.template | 1 + mkdocs/docs/HPC/VScode.md | 46 +++++++++++++++++++++++++++++++++++ 2 files changed, 47 insertions(+) create mode 100644 mkdocs/docs/HPC/VScode.md diff --git a/config/templates/hpc.template b/config/templates/hpc.template index 7076b094dc0..fe76f62a90d 100644 --- a/config/templates/hpc.template +++ b/config/templates/hpc.template @@ -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: diff --git a/mkdocs/docs/HPC/VScode.md b/mkdocs/docs/HPC/VScode.md new file mode 100644 index 00000000000..94fe694fdd6 --- /dev/null +++ b/mkdocs/docs/HPC/VScode.md @@ -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 + +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--`. +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) +