MatLab SSH Config
SSH configuration for early versions of MatLab. Originally content found on MatLab_DCS
The MATLAB Parallel Computing Toolbox uses SSH authentication via public-private key-pair to connect to the MATLAB Distributed Computing Server on the cluster head node.
The process of configuring SSH keys differs depending on your client operating system. Linux and Mac should already have the appropriate SSH client software installed, Windows will require the installation of PuTTY.
This section documents the steps to install and configure PuTTY on Windows computers. This software provides the utilities that MATLAB uses to communicate with the head node.
If PuTTY is installed, skip to the next section "Generate an SSH Key Pair".
Alternatively, you can download the individual components to a directory of your choosing. This install approach does not require Windows Administrator privileges:
NOTE: Using the individual component install approach requires that you add the installation directory to your PATH. See this Microsoft Support page for details on altering the PATH environment variable.
Generate an SSH Key Pair
Generate a public-private key pair by running the puttygen command.
Start PuTTYgen by either:
- Clicking Start -> All Programs -> PuTTY --> PuTTYgen
- Opening Windows Explorer / My Computer, browse to the PuTTY directory and double click 'puttygen'
This will bring up a window to manage your key pair.
Press the "Generate" button to start the process. You will be requested to move your mouse around in the blank are of that window to help generate a good random number. The progress bar will fill in as you do so letting you know when the process is complete. Once complete, the PuTTY Gen window will display your public key and offer you various options to work with that key.
- Change the "Key Comment" to your Windows host name (run 'hostname' at the command prompt to discover the name of your Windows system)
- Set a passphrase for your private key, filling in both the "Key passphrase" and "Confirm passphrase" text boxes with the same passphrase. The passphrase is a local password for this private key. It doesn't have anything to do with any other passwords. It is strictly about protecting the private key that you just generated. Please refer to the UAB IT page for instructions on creating a strong password. You need to remember this passphrase because you will be prompted for it whenever you use this key-pair.
- Press the "Save private key" button. The save button, will by default save the private key to your "My Documents" folder. This is fine, and you can give any file name you like. Just remember the name and where you saved it, so you can load it in the next steps.
- Keep your PuTTY Key Generator window open so we can use below when we register you public key with the SSH server.
- Remember your passphrase.
Create a Session Definition
The PuTTY tools that MATLAB Parallel Computing Toolbox leverages are configured by creating "Saved Sessions" PuTTY.
To create a PuTTY session for cheaha.uabgrid.uab.edu, follow these steps.
Start PuTTY by either:
- Clicking Start -> All Programs -> PuTTY --> PuTTY
- Opening Windows Explorer / My Computer, browse to the PuTTY directory and double click 'putty'
- This brings up the following dialog that has a collection of configuration categories in the "Category:" window on the left, and a context sensitive set of actions on the right. That is, if you change the category on the left you will change what you see on the right. The default category that you see is the Session, which is the main focus of our work here.
- In the default "Session" category, fill in the "Host Name (or IP address)" text box with "cheaha.uabgrid.uab.edu", and fill in the "Saved Sessions" text box with "cheaha.uabgrid.uab.edu". Press the "Save" button
- Select the "Data" sub-category under the "Connection" category from the left-side Category browser. Fill in the "Auto-login username" text box with the username for your account on cheaha.
- Select the "Session" category, and press "Save" again. You now have a saved session ready for use.
- Press the "Open" button at the bottom on the dialog. This will bring up a login window with a login prompt for your password. Provide your cheaha password to login. Keep this session open, as you will use it in the next section.
Register Your Public Key
In order to use your public-private key-pair to start an SSH session, you need to register you public key with cheaha by adding your public key to the list of authorized keys for that SSH server.
- Use the SSH connection established in the previous step
- In the PuTTYgen window text area labeled "Public key for pasting into OpeSSH authorized_keys file:", select the public key by right clicking the key and clicking "Select All". Copy the key by right clicking again and selecting "Copy"
- In the SSH session window, enter the command
- Press the SHIFT and o keys (in other words, a capital letter O), and the press your right mouse button over this window. This will paste your public key onto a new line. Press the Escape (Esc) key, press the key sequence colon-w-q-enter (:wq Enter)
- Fix the file permissions using the command
chmod u=rw $HOME/.ssh/authorized_keys
- End the session. Type the command
You can close the PuTTY Configuration and PuTTY Key Generator windows now if you haven't already done so.
Load Your Private Key
Loading your private key is the first step you will take prior to using MATLAB to submit jobs to cheaha. This step essentially activates your key so that all PuTTY-based tools can use it in their operations.
Start PuTTYagent by either:
- Clicking Start -> All Programs -> PuTTY --> PuTTYagent
- Opening Windows Explorer / My Computer, browse to the PuTTY directory and double click 'pagent'
- Click on the icon to bring up the Pageant Key List dialog
- Press the "Add Key" button. From the file dialog, select the private key created above (in My Documents by default)
- Press "Open" on the file dialog, you will be prompted for the passphrase to load your private key. Enter in the passphrase and click OK
The private key should now be loaded and ready for use with all PuTTY-based tools. Click the close button to minimize PuTTYagent.
Warning: While Pagent is running and has your private key loaded, anyone else using your computer can access your account on Cheaha. Please LOCK your workstation when unattended!
You are now ready to begin using the MATLAB Parallel Computing Toolbox.
If you don't already have an RSA key-pair generated for your user account on your workstation, do so by running the following command (choose a good passphrase)
$ ssh-keygen -t rsa Enter file in which to save the key (~/.ssh/id_rsa): Enter passphrase (empty for no passphrase): Enter same passphrase again:
Copy the public key to cheaha (change USERID to your cheaha login id). You will be prompted for your cheaha password.
$ ssh-copy-id -i $HOME/.ssh/id_rsa.pub USERID@cheaha.rc.uab.edu
Add your cheaha's userid to your local .ssh/config. (open up in an editor - vi/emacs/geanie)
Host *rc.uab.edu user=<your-user-id>
Run ssh-agent to load the key on your Linux workstation
$ ssh-agent Enter passphrase for ~/.ssh/id_rsa: Identity added: ~/.ssh/id_rsa (~/.ssh/id_rsa)
Now test that you can connect to cheaha without entering a password (again change USERID to your login name)
$ ssh USERID@rc.uabgrid.uab.edu uptime 15:34:10 up 9 days, 5:11, 14 users, load average: 0.25, 0.34, 0.50
Steps for Mac are same as for Linux, except that, on MacOSX ssh-copy-id command is not included. So, append the RSA-key from Mac desktop to Cheaha, using the following command:
cat $HOME/.ssh/id_rsa.pub | ssh USERID@cheaha.rc.uab.edu "cat >> ~/.ssh/authorized_keys"
NOTE: There is already a key in the authorized_keys file on Cheaha, by mistake if you delete or overwrite that you will have problems submitting jobs on Cheaha. So make sure you follow the above instructions correctly.