Page Comparison

Generating and Configuring SSH Key Pairs

Follow the steps below to configure  a new SSH key pair in anticipation of accessing a cluster with SSH. Once you have generated and configured your SSH key pair for the cluster, you do not have to do this step each time.

Note: These instructions are written generally for OpenSSH and some programs, such as VS Code, are not compatible with this configuration using alternative SSH solutions like PuTTY. 

Step 1 - Generate SSH Key Pair

First, you'll need to create and configure an SSH pair for each node you'll be connecting to, a great secure solution to connection. 

Open a Terminal

Open a terminal based on your operating system.

• Windows - Command Prompt or Git Bash
• MacOS or Linux - Terminal

Generate the SSH Key Pair

In the terminal, generate your SSH key pair with the following command. Be sure to give the key pair a comment that allows you to identify it. This could be your email address, netid, cluster name, etc.

# Example Key Generation
ssh-keygen -t rsa -b 4096 -C "<comment; ex.netid or email cluster-name>"

You'll be prompted to choose a location to save the key pair. This will default to '~/.ssh/id_rsa'. Be sure to notate if you choose another location. 

You also have the option to set a passphrase. If you prefer to not, simple hit 'Enter' to skip. 

Step 2 - Add the SSH Public Key to the Cluster

Next, you'll need to add the public key to each node you intend to connect to using this key noting that you can certainly generate a new key for each node. Being by displaying and copying your 

Copy the Public Key

Use a corresponding terminal to display the public key so that you can copy it. 

# CMD
type %USERPROFILE%\.ssh\id_rsa.pub

# Shell
cat ~/.ssh/id_rsa.pub

Add the Public Key to the Login Node

Next, connect to the cluster and add the public key. Repeat this step for other nodes as needed. 

# Make the .ssh directory in your home directory
mkdir -p ~/.ssh

# Put the copied public key into your authorized_keys file
echo "your_copied_public_key" >> ~/.ssh/authorized_keys

# Ensure the .ssh locations have the correct permissions
chmod 700 ~/.ssh
chmod 600 ~/.ssh/authorized_keys

Step 3 - Configure VS Code for SSH

Lastly, you'll need to ensure VS Code is configured to make the SSH connection. 

Install the Remote - SSH Extension

With VS Code open, go to the Extensions view (control + shift + x is the shortcut).

Search 'Remote - SSH' and install it. 

Image Added

Add SSH Host in VS Code

Next, add the SSH Host connection in VS Code. To do so, press 'F1' to open the Command Palette. 

In the Command Palette, type 'Remote-SSH: Connect to Host...' and select it. 

Enter the login node connection string and press enter (ex. "yournetid>@its-og-login1.syr.edu"). 

Image Added

Configure SSH Settings

You should be prompted to select the file where the SSH configuration will be saved. This is likely '~/.ssh/config' or 'C:\Users\<netid>\.ssh\config'. 

You should be prompted to either 'Open Config' or 'Connect'. You should select 'Open Config' so that you can ensure the SSH key pair is added appropriately. 

Image Added
The information for your host should look like the following notating that you'll want similar information for each host.

# Example Host Connection Configuration
Host its-og-login1.syr.edu
	HostName its-og-login1.syr.edu
	User <your-netid>
	IdentifyFile <SSH key location, ex. "~/.ssh/id_rsa"> 

Be sure to save the configuration file if you've made any changes. 

Connect to the SSH Host

Finally, connect to your host. To do so, press 'F1' to open the Command Palette. 

In the Command Palette, this time type 'Remote-SSH: Connect to Host...' and select it. 

You should now see the intended host. Select it and you should be connect. 

SSH Key Pair Compatibility

Below is a list of known compatible SSH solutions with this configuration type. 

Getting Help

Question about Research Computing? Any questions about using or acquiring research computing resources or access can be directed at researchcomputing@syr.edu.