HPC/Network Access/PuTTY Configuration: Difference between revisions

Latest revision as of 16:48, March 10, 2021

The Carbon cluster is reachable from networks outside of Argonne through SSH tunneling or VPN, either of which has advantages and disadvantages. This page explains how to set up and use SSH tunneling.

Should your connection attempt fail, first review your access requirements and take steps as indicated.

Configuring

The following steps need to be performed once for each workstation you wish to use to access Carbon.

The SSH Gateway
The Carbon login nodes
Accessing Carbon licenses remotely (advanced)

Connecting

To connect to Carbon for interactive work, or to access its networked licenses, perform a preparatory step, needed only once for a given Windows login session.

Connecting to the SSH Gateway

From then on, and while the preparatory window remains active, connect as often as desired.

Connecting to a Carbon login node

File Transfers using PSFTP

Configure your PuTTY installation as shown above.
Connect to the SSH Gateway, as shown in the preceeding section.
Open the psftp application.
Use clogin (your configured PuTTY saved session name) as host to connect to.

To learn more, see the PSFTP documentation.

Support

If you have difficulties connecting:

Stop all open PuTTY sessions.
Review the PuTTY configuration for both the SSH Gateway profile and the Carbon Login profile, as shown in section #Configuring above.
- Make sure that tunneled port numbers match between the two profiles.
Carefully follow the steps at #Connecting . Remember:
- You need one preparatory connection to the SSH gateway running, then you can open one or more terminal or file transfer connections.
- For the connection framework described here, open all SSH connections from your own machine, never from Mega.

If you still have difficulties, submit a support request with Remote Acces chosen from the drop-down menu Type of Request or Issue.

@@ Line 1: / Line 1: @@
-== Introduction ==
+The Carbon cluster is reachable from networks outside of Argonne through SSH tunneling or VPN,
-The Carbon cluster is reachable from networks outside Argonne only through SSH tunneling or VPN.
+either of which has advantages and disadvantages. This page explains how to set up and use SSH tunneling.
-Either way has advantages and disadvantages.  This page explains how to connect through an ssh tunnel.
-Tunneling is a two-step process:
+Should your connection attempt fail, first review your [[../#Requirements|'''access requirements''']] and take steps as indicated.
-# Establish the tunnel.
-# Connect through the tunnel.
-[[media:HPC_Using_Carbon_-_II_Remote_Access.pdf|Overview slides (pdf)]] and [[HPC/Network_Access/SSH_Tunnel_Setup_on_Linux_and_MacOS| specifics for Carbon]] are detailed elsewhere.  The PuTTY setup for both steps is illustrated below.
+<!--
+[[media:HPC_Using_Carbon_-_II_Remote_Access.pdf|Overview slides (pdf)]] and [[HPC/Network_Access/SSH_Tunnel_Setup_on_Linux_and_MacOS| specifics for Carbon]] are detailed elsewhere.  The PuTTY setup for both steps is explained below.
 Note that the ''PuTTY Configuration'' panel is somewhat idiosyncratic to operate, notably regarding the concept of ''Sessions''.  Numerous [http://images.google.com/images?um=1&hl=en&rls=en-us&q=PuTTY+ssh&btnG=Search+Images screenshots on Google] provide general guidance.
+-->
-== Configuration ==
+== Configuring ==
-=== Configure first session ===
+The following steps need to be performed once for each workstation you wish to use to access Carbon.
-# Open PuTTY. The PuTTY Configuration window will appear.
+* [[HPC/Network Access/PuTTY Configuration/The SSH Gateway | The SSH Gateway]]
-#: [[Image:HPC 2012-08 PuTTY config 1 new.png]]
+* [[HPC/Network Access/PuTTY Configuration/The Carbon login nodes | The Carbon login nodes]]
-#: There are many configuration panels that will appear in the main part of the window. The panels are organized as a tree, shown in the left-hand side of the window. Each panel can be reach by clicking on the leaf names of the tree.
+* [[HPC/Network Access/PuTTY Configuration/Accessing Carbon licenses remotely | Accessing Carbon licenses remotely]] (advanced)
-# If you already have a session named '''Mega''' shown in the bottom right list of the main panel, push the Load button.
-#: [[Image:HPC 2012-08 PuTTY config 2 present.png]]
-# Click Data in the tree. In the Login details section of the panel enter your username.
-#* Auto-login username:  '''username'''
-#: [[Image:HPC 2012-08 PuTTY config 3 username.png]]
-# Click SSH in the tree
-# Click the checkbox '''Don't start a shell or command at all''' in the Protocol options section.
-#: [[Image:HPC 2012-08 PuTTY config 4a command.png]]
-# Click the "+" symbol near SSH to open its sub-tree.
-# Click Tunnels. Under Add new forwarded port, enter:
-#* Source port: '''33301'''
-#* Destination: '''clogin:22'''
-#* Push the Add button. A new entry will appear in the middle field, shown as:
-#*::  L33301&em;clogin:22
-*: The letter "L" denotes a port on the local host.
-#: [[Image:HPC 2012-08 PuTTY config 4 tunnels new.png]][[Image:HPC 2012-08 PuTTY config 5 tunnels mega.png]]
-# Scroll to the top of the tree and click Session. Enter the host details:
-#* Host name: '''mega.cnm.anl.gov'''
-#* Port: '''22'''  (leave at the default).
-#* Protocol: SSH (leave at the default).
-#* In the Saved Sessions field, enter '''Mega'''
-#* Push Save. The entry will appear in the list of saved sessions.
-#: [[Image:HPC 2012-08 PuTTY config 6 Save.png]]
-=== Configure second session ===
+== Connecting ==
-# In the PuTTY Configuration window, click Session at the top of the tree on the left.
+To connect to Carbon for interactive work, or to access its networked licenses, perform a preparatory step, needed only once for a given Windows login session.
-# Select the '''Mega''' session and push Load. This session will be the basis for the next steps.
+* [[HPC/Network Access/PuTTY Configuration/Connecting to the SSH Gateway | Connecting to the SSH Gateway]]
-# Click SSH in the tree
+From then on, and while the preparatory window remains active, connect as often as desired.
-# '''Uncheck''' the checkbox '''Don't start a shell or command at all'''.
+* [[HPC/Network Access/PuTTY Configuration/Connecting to a Carbon login node | Connecting to a Carbon login node]]
-# Click X11 in the tree.
-#* Click the checkbox '''Enable X11 forwarding'''.
-#* Set X display location to ''':0'''
-#: [[Image:HPC 2012-08 PuTTY config 7 X11.png]]
-# Click Tunnels.
-* Select the '''L33301''' entry and push Remove. There should be no forwarded ports listed.
-# Under Add new forwarded port, enter:
-#* Source port: '''6200'''
-#* Destination: '''mgmt03:6200'''
-#* Push the Add button.
-# Repeat with the following settings:
-#* Source port: '''6201'''  (not 6200!)
-#* Destination: '''mgmt04:6200'''
-#* Push the Add button.
-# Repeat once more as follows:
-#* Source port: '''6202'''
-#* Destination: '''sched1:6200'''
-#* Push the Add button.
-#: You should see tree entries:
-*:* L6200&nbsp;&nbsp;mgmt03:6200
-*:* L6201&nbsp;&nbsp;mgmt04:6200
-*:* L6202&nbsp;&nbsp;sched1:6200
-#: [[Image:HPC 2012-08 PuTTY config 8 VNL enter.png]][[Image:HPC 2012-08 PuTTY config 9 VNL done.png]]
-# Scroll to the top of the tree and click Session. Enter the host details:
-#* Host name: '''localhost'''
-#* Port: '''33301'''  (referring to the tunnel set up above as L33301.)
-#* Protocol: SSH (leave at the default).
-#* In the Saved Sessions field, enter '''Clogin'''
-#* Push Save. The entry will appear in the list of saved sessions.
-#: [[Image:HPC 2012-08 PuTTY config 10 Save.png]]
-== Connecting to Mega ==
+== File Transfers using PSFTP ==
-# In the PuTTY Configuration window, click Session at the top of the tree on the left.
+# [[#Configuring | Configure your PuTTY installation]] as shown above.
-# Select the session named '''Mega''' and push Load.
+# [[#Connecting | Connect to the SSH Gateway]], as shown in the preceeding section.
-# Make sure the Host Name field shows mega.cnm.anl.gov.
+# Open the <code>psftp</code> application.
-# Push Open.
+#: Use <code>clogin</code> (your configured PuTTY saved session name) as host to connect to.
-#: [[Image:HPC 2012-08 PuTTY config 11 Load mega.png]]
-# When prompted, enter your Argonne account password. When accepted, the cursor will wait at the next line and nothing further will happen.
-#:[[Image:HPC 2012-08 PuTTY config 12 Open mega.png]]
-# Minimize the window.
-== Connecting to Carbon itself ==
+To learn more, see the [https://the.earth.li/~sgtatham/putty/0.71/htmldoc/Chapter5.html#pscp PSFTP documentation].
-# Open another PuTTY window.
-# Select the session named '''Clogin''' and push Load.
-# Make sure the Host Name field shows localhost.
-#:[[Image:HPC 2012-08 PuTTY config 13 Load clogin.png]]
-# Push Open.
-# Welcome to Carbon! - You should get our NOTICE TO USERS and a prompt saying login5 or login6 followed by /home/username.
-== Setup for step 2 ==
+== Support ==
-[[Image:putty-session-clogin.png]]
+If you have difficulties connecting:
+# Stop all open PuTTY sessions.
+# Review the PuTTY configuration for ''both''  the SSH Gateway profile and the Carbon Login profile, as shown in section [[#Configuring]] above.
+#* Make sure that ''tunneled port numbers match'' between the two profiles.
+# Carefully follow the steps at [[#Connecting]] . Remember:
+#* You need ''one preparatory'' connection to the SSH gateway running, then you can open ''one or more'' terminal or file transfer connections.
+#* For the connection framework described here, open ''all'' SSH connections from ''your'' own machine, ''never'' from Mega.
+If you still have difficulties, [[HPC/Support#Compose a support request for CNM HPC | '''submit a support request''']] with ''Remote Acces'' chosen from the drop-down menu ''Type of Request or Issue''.
 [[Category:HPC|Network]]