Skip to content

Update SSH instructions to avoid unnecessary usage of bastion node - #299

Merged
IgorTatarnikov merged 12 commits into
mainfrom
ns-update-ssh-instructions
Oct 8, 2026
Merged

IgorTatarnikov merged 12 commits into
mainfrom
ns-update-ssh-instructions

Conversation

@niksirbi

@niksirbi niksirbi commented Jul 14, 2026 •

Copy link
Copy Markdown
Member

Ports neuroinformatics-unit/HowTo#78 to this repository, as agreed in #294.

Changes

Same content changes as the source PR, applied to docs/source/howto/programming/SSH-SWC-cluster.md (the _static paths differ here, so this was applied by hand rather than cherry-picked):

  • Log into the cluster: distinguish the two scenarios. From within the SWC network (wired connection or VPN) you can ssh to the gateway directly; only from outside do you need to hop through the bastion node.
  • "Why do we SSH twice?" → "Types of HPC nodes", with the bastion/gateway/compute distinction presented as a table.
  • Windows note, managed-desktops note and SSH config/keys sections updated to match. I removed the explanded flowchart that also included managed machines, because it was getting too complex. The SSH config is still representing the "outside the SWC network" case, as this is were aliases and proxy-jumps are most useful.

Testing

sphinx-build runs clean.

How to review

Instead of inspecting the diff, I recommend rendering the updated guide and reading it as is. Double check it works with the cluster's current configuration.

Ported from neuroinformatics-unit/HowTo#78

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@niksirbi
niksirbi force-pushed the ns-update-ssh-instructions branch from 340f090 to 441e543 Compare October 6, 2026 16:27
@niksirbi
niksirbi marked this pull request as ready for review October 7, 2026 10:11

@IgorTatarnikov IgorTatarnikov 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.

This looks great, just a few small comments.

The only thing that's blocking is the appearance of the flow chart in dark mode. Is it possible to have a background for the whole figure or create a light and dark version?

Comment thread docs/source/howto/programming/SSH-SWC-cluster.md Outdated
Comment thread docs/source/howto/programming/SSH-SWC-cluster.md Outdated
Comment thread docs/source/howto/programming/SSH-SWC-cluster.md Outdated
Comment thread docs/source/howto/programming/SSH-SWC-cluster.md
Comment thread docs/source/howto/programming/SSH-SWC-cluster.md Outdated
Comment thread docs/source/howto/programming/SSH-SWC-cluster.md Outdated

@IgorTatarnikov IgorTatarnikov 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.

LGTM 🎉

Thanks for addressing the comments!

@IgorTatarnikov
IgorTatarnikov merged commit 7f8d594 into main Oct 8, 2026
4 checks passed
@IgorTatarnikov
IgorTatarnikov deleted the ns-update-ssh-instructions branch October 8, 2026 09:49
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