Skip to content

[Tutorial/Workflow/Doc] VSCode on a compute node via Remote-SSH #18

Description

@KaiPonel

🧾 Summary

Documents how to attach a local VSCode to a Cannon compute node over SSH, as an
alternative to the Open OnDemand web view. Covers the SSH ProxyJump config that
makes compute nodes reachable, what the salloc flags mean, and the reconnect
behaviour when an allocation ends.

🎯 Learning Goals / Outcomes

  • Set up an SSH config that reaches any Cannon compute node in one hop
  • Request an interactive allocation and understand each salloc flag
  • Connect VSCode Remote-SSH to that node and know why the login node is the wrong target

📦 Required Tools, Packages, or Data

  • Tools: VSCode with the Remote - SSH extension, OpenSSH, Slurm
  • Libraries: N/A
  • Data source(s): N/A

📄 Outline / Structure

  1. Why this exists, and why not the login node
  2. Quick steps
  3. The SSH config, block by block
  4. What the salloc flags mean
  5. Connecting VSCode
  6. Allocations do not survive: the tradeoff vs OOD
  7. When to use OOD instead

🔗 Related Materials

🚦Status & Next Steps

  • Ready for Review

Draft written, PR to follow. Requested by Tinashe.

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

Status
🎉Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions