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 1/5] 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) + From cff368e0308679bbf8953e1f3c446037cd3b5d7d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bal=C3=A1zs=20Hajgat=C3=B3?= Date: Fri, 4 Oct 2024 12:28:47 +0200 Subject: [PATCH 2/5] Fix typo --- mkdocs/docs/HPC/VScode.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs/docs/HPC/VScode.md b/mkdocs/docs/HPC/VScode.md index 94fe694fdd6..626f1021b19 100644 --- a/mkdocs/docs/HPC/VScode.md +++ b/mkdocs/docs/HPC/VScode.md @@ -17,7 +17,7 @@ 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"++ +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 From 8b6766cd339145e026585fbfffd3d71dd2c261fe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bal=C3=A1zs=20Hajgat=C3=B3?= Date: Fri, 4 Oct 2024 13:52:27 +0200 Subject: [PATCH 3/5] reflexing to comments --- config/templates/hpc.template | 2 +- mkdocs/docs/HPC/VScode.md | 46 --------------------------- mkdocs/docs/HPC/vscodetunnel.md | 56 +++++++++++++++++++++++++++++++++ 3 files changed, 57 insertions(+), 47 deletions(-) delete mode 100644 mkdocs/docs/HPC/VScode.md create mode 100644 mkdocs/docs/HPC/vscodetunnel.md diff --git a/config/templates/hpc.template b/config/templates/hpc.template index fe76f62a90d..8d3c039f99a 100644 --- a/config/templates/hpc.template +++ b/config/templates/hpc.template @@ -59,7 +59,7 @@ nav: - OpenFOAM: openFOAM.md - Python: python.md - Python virtual environments: setting_up_python_virtual_environments.md - - VS Code Tunnel: VScode.md + - VS Code Tunnel: vscodetunnel.md - FAQ: - Frequently Asked Questions: FAQ.md - Appendices: diff --git a/mkdocs/docs/HPC/VScode.md b/mkdocs/docs/HPC/VScode.md deleted file mode 100644 index 626f1021b19..00000000000 --- a/mkdocs/docs/HPC/VScode.md +++ /dev/null @@ -1,46 +0,0 @@ -# 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) - diff --git a/mkdocs/docs/HPC/vscodetunnel.md b/mkdocs/docs/HPC/vscodetunnel.md new file mode 100644 index 00000000000..95b11c63320 --- /dev/null +++ b/mkdocs/docs/HPC/vscodetunnel.md @@ -0,0 +1,56 @@ +# 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). +To connect to the `VS Code` tunnel using the URL via a web browser is not supported, +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 the [remote development](https://code.visualstudio.com/docs/remote/remote-overview) +extension pack 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. + +!!! Warning + If you are an UGent user, and you get an error message something like "You do not have access to this" + during the Microsoft Authentication, then you might have to + [whitelist yourself](https://dictselfservice.ugent.be/index.php?page=requestform&form=deviceCodeAuth) + You can use as motivation "Needed for `VS Code` tunnel for HPC" (You have to do it only once.) + + Please be aware, that it might take up to half an hour until the whitelisting become effective. + + +If you are not connected automatically to the tunnel, please select "connect to..." and then +"Connect 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. +If you suspect that the too old version of CLI might cause problem, please send us a +[software installation request](https://www.ugent.be/hpc/en/support/software-installation-request) +for `coder-cli`. + +Please do not use `VS Code` to ssh to the login nodes, +but always use a `VS Code` Tunnel connection, +preferably using the [interactive and debug cluster](./interactive_debug.md) + From f0bbd81b36726bb4f406c36046f70ca761e45437 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bal=C3=A1zs=20Hajgat=C3=B3?= Date: Fri, 4 Oct 2024 13:54:38 +0200 Subject: [PATCH 4/5] reflexing to comments --- mkdocs/docs/HPC/vscodetunnel.md | 1 + 1 file changed, 1 insertion(+) diff --git a/mkdocs/docs/HPC/vscodetunnel.md b/mkdocs/docs/HPC/vscodetunnel.md index 95b11c63320..38073314308 100644 --- a/mkdocs/docs/HPC/vscodetunnel.md +++ b/mkdocs/docs/HPC/vscodetunnel.md @@ -28,6 +28,7 @@ In the new browser tab or window, for the question Then follow the instruction to authenticate yourself. !!! Warning + If you are an UGent user, and you get an error message something like "You do not have access to this" during the Microsoft Authentication, then you might have to [whitelist yourself](https://dictselfservice.ugent.be/index.php?page=requestform&form=deviceCodeAuth) From 84fb2602fa2dfab27a8ec9a8d2178a9a1f04ea5d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bal=C3=A1zs=20Hajgat=C3=B3?= Date: Fri, 4 Oct 2024 13:56:18 +0200 Subject: [PATCH 5/5] reflexing to comments --- mkdocs/docs/HPC/vscodetunnel.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs/docs/HPC/vscodetunnel.md b/mkdocs/docs/HPC/vscodetunnel.md index 38073314308..b1e2ad14f62 100644 --- a/mkdocs/docs/HPC/vscodetunnel.md +++ b/mkdocs/docs/HPC/vscodetunnel.md @@ -49,7 +49,7 @@ but the upgrade rate of the App/CLI is very high, so it is hard for us to follow it tightly. If you suspect that the too old version of CLI might cause problem, please send us a [software installation request](https://www.ugent.be/hpc/en/support/software-installation-request) -for `coder-cli`. +for `code-cli`. Please do not use `VS Code` to ssh to the login nodes, but always use a `VS Code` Tunnel connection,