SSH on local Windows workstation

If you would rather connect to your cluster using your own terminal on your machine, you must configure an SSH key in your Job settings prior to submitting your job. Instructions to for setting up your SSH key and connecting to your cluster can be found in the sections below.

Before connecting to the cluster, an existing public/private SSH keypair should exist or be newly created. The public key should then be added to your Rescale Account on the the Job Settings page. Please follow the steps given below depending on the type of workstation


Using PuTTY

You can use PuTTYgen to generate your public/private keypair. PuTTY is a free open-source terminal emulator that functions much like the Terminal application in Mac OSX. You can download PuTTY from here. The PuTTYgen utility also comes with the PuTTY client installation.

To generate an SSH key with PuTTYgen, follow these steps:

  • Launch the PuTTYgen program
  • For Type of key to generate, select SSH-2 RSA under Key in the menu bar
  • Click the Generate button
  • Move your mouse in the area below the progress bar to provide randomness for the key generation algorithm. When the progress bar is full, PuTTYgen has generated your key pair

putty-generate-key.png

  • Click the Save private key button to save the private key. Please save it in an accessible location.

  • It is recommended that you use Pageant to save your SSH key for easy access and use within your command prompt

putty-copy-key.png

  • Right-click in the text field labeled Public key for pasting into OpenSSH authorized_keys file and choose Select All
  • Right-click again in the same text field and choose Copy
  • On your Rescale platform account page, click on the <user>@rescale.com button at the top right corner
  • Select Account in the drop-down menu
  • Click on Job Settings option on the left side of the page

AccessJobSettings.png

  • Once you have copied the contents of your public key, paste the contents of the public key into the SSH Public Key field. Click Save and you are able to SSH into all your future clusters

  • The Access Restriction (CIDR range) field allows you to select which IP addresses can access your cluster. The options Everywhere or My Current IP Address can be set automatically from the pull-down menu. You can also specify your own custom Classless Inter-Domain Routing (CIDR) rule by editing the Access Restriction (CIDR) range text field directly

  • In Windows, you can use PuTTY as an SSH client to connect to your cluster on Rescale

  • When you provision a cluster, the Job Logs window on the Status tab will display a message showing the job's username on the system and the public IP address of the master node of the cluster. The message will look like this:

job-logs.png

  • In this example, the job username is uprod_qpWia and the public IP address is 107.23.132.81. You will need this information when using PuTTY. To log in to your machine, follow these instructions:

  • Launch the PuTTY program

  • Type the public IP address of your Rescale cluster in the Host Name (or IP address) field

  • In the Category panel on the left, expand the SSH section to expose the authentication (Auth) settings

putty-config-connect.png

  • Click Auth to display settings controlling SSH authentication.
  • Click Browse under Private key file for authentication and select the private key file you created previously

putty-config-auth.png

Based on the the type of connection to the cluster that you need for your workflow, you may need either a regular SSH session or an SSH tunnel connection:

For a regular SSH session

  • Click Open to start a PuTTY terminal session

For an SSH tunnel connection

  • Click Tunnels to display port forwarding settings.

  • Type the Source port and Destination in the fields provided; this is specific to the server program and is provided to you:

    • Source port: ####
    • Destination: localhost:####
  • Click Add to forward this port to your ssh tunnel configuration

  • Click Open to start a Putty terminal session

    ssh-tunnel.png

When you connect to your cluster for the first time, you may see a PuTTY Security Alert warning you that the host's key is not cached in the the registry. Do not be alarmed; this is a normal warning. Click yes to continue.

Follow these steps to log in:

  • At the login as: prompt, type the username, for instance uprod_qpWia and press Enter
login as: uprod_qpWia
  Authenticating with public key "rsa-key-1234"
  Passphrase for key "rsa-key-1234":
  • You should now be logged into your machine