Skip to content

Add VSCode Remote SSH connection guide - #402

Open
Amanda-dong wants to merge 12 commits into
mainfrom
jupyter-with-vscode-on-torch
Open

Add VSCode Remote SSH connection guide#402
Amanda-dong wants to merge 12 commits into
mainfrom
jupyter-with-vscode-on-torch

Conversation

@Amanda-dong

Copy link
Copy Markdown
Contributor

Added a guide for connecting VSCode to Apptainer Jupyter Notebook environments via SSH, including steps for SSH key generation, configuration, and connection.

Added a guide for connecting VSCode to Apptainer Jupyter Notebook environments via SSH, including steps for SSH key generation, configuration, and connection.
@github-actions

github-actions Bot commented Jul 24, 2026

Copy link
Copy Markdown
Contributor
PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://NYU-RTS.github.io/rts-docs/pr-preview/pr-402/

Built to branch gh-pages at 2026-08-20 07:20 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@Amanda-dong
Amanda-dong marked this pull request as ready for review July 24, 2026 08:14
Updated instructions for connecting VSCode to the Torch login node, including SSH configuration and connection steps.

Configure Remote - SSH settings:
- Check off `Remote.SSH: Lockfiles In Tmp`
- Uncheck `Remote.SSH: Use Flock`

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Uncheck'?


`Install in SSH: torch`

## Step 2: Start a dummy batch job and connect to the compute node

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[TitleCase.TitleCase] 'Step 2: Start a dummy batch job and connect to the compute node' should use title case

@@ -0,0 +1,38 @@
# Connect VSCode to Torch

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [remark-lint] reported by reviewdog 🐶
Error: Could not find module remark-lint-no-undefined-references

@@ -0,0 +1,54 @@
# Use Apptainer Jupyter Notebooks in VSCode on Torch

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [remark-lint] reported by reviewdog 🐶
Error: Could not find module remark-lint-no-undefined-references


Configure Remote - SSH settings:
1. Check off `Remote.SSH: Lockfiles In Tmp`
2. Uncheck `Remote.SSH: Use Flock`

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Uncheck'?

@s-sajid-ali

Copy link
Copy Markdown
Member

@Amanda-dong : We also offer code-server as an OpenOnDemand app: https://github.com/coder/code-server

Try it out and explain how using code-server can be easier to use when compared to the hassles of SSH 2fa login and dummy compute job process.


Configure Remote - SSH settings:
1. Check off `Remote.SSH: Lockfiles In Tmp`
2. Uncheck `Remote.SSH: Use Flock`

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] <Vale.Spelling> reported by reviewdog 🐶
Did you really mean 'Uncheck'?

Suggested change
2. Uncheck `Remote.SSH: Use Flock`
2. Recheck `Remote.SSH: Use Flock`
Suggested change
2. Uncheck `Remote.SSH: Use Flock`
2. Check `Remote.SSH: Use Flock`
Suggested change
2. Uncheck `Remote.SSH: Use Flock`
2. Pinchbeck `Remote.SSH: Use Flock`


`Install in SSH: torch`

## Step 2: Start a dummy batch job and connect to the compute node

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] <TitleCase.TitleCase> reported by reviewdog 🐶
'Step 2: Start a dummy batch job and connect to the compute node' should use title case

@s-sajid-ali s-sajid-ali left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall, it would be better to add a full page on code-server at rts-docs/docs/hpc/09_ood.

Then, use this page to start with a reference to it as the preferred option and only using VSCode if necessary.

We now also ask users to add the Torch compute node hosts to their ssh config file at https://services.rt.nyu.edu/docs/hpc/connecting_to_hpc/connecting_to_hpc/#configuring-your-ssh-client . It's best to refer to it rather than add a new code block as we may forget to add the compute node section.

Comment thread docs/hpc/06_tools_and_software/09_vscode_remote_ssh_torch.mdx Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants