-
Notifications
You must be signed in to change notification settings - Fork 35
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add VS Code Tunnel recommendations #747
Changes from 2 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
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. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This neds to be clarified: this is the to connect to the tunnel URL via a browser |
||
|
||
## Prerequisites | ||
|
||
We do recommend to install remote developent for the VS Code App. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
||
|
||
## 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" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. is there a way to make this a warn or tip or info block? @boegel do you know how to do this? |
||
durng the Microsoft Authentication, then you might have to | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. during |
||
[whitelist yourself](https://dictselfservice.ugent.be/index.php?page=requestform&form=deviceCodeAuth) | ||
(You have to do it only once.) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. add that this is only for ugent users and they can use |
||
|
||
If you are not connected automatically to the tunnel, please select "connect to..." and then | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. where is this? is this in the local vscode? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes. When you open |
||
"Connet to Tunnel" using Microsoft Account and select the tunnel named `vsc-<your vsc account>-<cluster>`. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. connect |
||
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. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
||
Please do not use VS Code to ssh to the login nodes, | ||
but always use a VS Code Tunnel conection, | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. connection |
||
peferably using the [interactive and debug cluster](./interactive_debug.md) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. preferably |
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
use "
VS Code
" (with backticks, and consistent uppercase, see line below)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe rename the md file to vscodetunnel, i think the url now would be like
.../vscode
. if this is only about the tunnel, make it more clear