Skip to content

Commit 8b6766c

Browse files
committed
reflexing to comments
1 parent cff368e commit 8b6766c

File tree

3 files changed

+57
-47
lines changed

3 files changed

+57
-47
lines changed

config/templates/hpc.template

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ nav:
5959
- OpenFOAM: openFOAM.md
6060
- Python: python.md
6161
- Python virtual environments: setting_up_python_virtual_environments.md
62-
- VS Code Tunnel: VScode.md
62+
- VS Code Tunnel: vscodetunnel.md
6363
- FAQ:
6464
- Frequently Asked Questions: FAQ.md
6565
- Appendices:

mkdocs/docs/HPC/VScode.md

Lines changed: 0 additions & 46 deletions
This file was deleted.

mkdocs/docs/HPC/vscodetunnel.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
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+
To connect to the `VS Code` tunnel using the URL via a web browser is not supported,
10+
since web access might not work from all browser or operational system.
11+
The only confirmed way to connect via a browser is using Windows 11 and Edge.
12+
13+
## Prerequisites
14+
15+
We do recommend to install the [remote development](https://code.visualstudio.com/docs/remote/remote-overview)
16+
extension pack for the `VS Code` App.
17+
18+
19+
## Connection
20+
21+
In the [web portal](./web_portal.md), under the "Interactive Apps" choose `VS Code` Tunnel,
22+
select the parameters and launch your job by clicking ++"Launch"++
23+
When your job has started, connect by clicking ++"Connect"++
24+
25+
In the new browser tab or window, for the question
26+
`How would you like to log in to Visual Studio Code?` choose `Microsoft Account`
27+
(using the arrow keys on your keyboard, then hit ++"Enter"++).
28+
Then follow the instruction to authenticate yourself.
29+
30+
!!! Warning
31+
If you are an UGent user, and you get an error message something like "You do not have access to this"
32+
during the Microsoft Authentication, then you might have to
33+
[whitelist yourself](https://dictselfservice.ugent.be/index.php?page=requestform&form=deviceCodeAuth)
34+
You can use as motivation "Needed for `VS Code` tunnel for HPC" (You have to do it only once.)
35+
36+
Please be aware, that it might take up to half an hour until the whitelisting become effective.
37+
38+
39+
If you are not connected automatically to the tunnel, please select "connect to..." and then
40+
"Connect to Tunnel" using Microsoft Account and select the tunnel named `vsc-<your vsc account>-<cluster>`.
41+
Please note that right now you can only have one tunnel per cluster.
42+
43+
If you are asked to update `VS Code` CLI on your remote server, choose ++"Not Now"++.
44+
You do not have permission to update the CLI, as it is centrally installed.
45+
This means that your `VS Code` App is newer than the CLI on our systems.
46+
We update the centrally installed CLI time to time,
47+
but the upgrade rate of the App/CLI is very high,
48+
so it is hard for us to follow it tightly.
49+
If you suspect that the too old version of CLI might cause problem, please send us a
50+
[software installation request](https://www.ugent.be/hpc/en/support/software-installation-request)
51+
for `coder-cli`.
52+
53+
Please do not use `VS Code` to ssh to the login nodes,
54+
but always use a `VS Code` Tunnel connection,
55+
preferably using the [interactive and debug cluster](./interactive_debug.md)
56+

0 commit comments

Comments
 (0)