This document is for accessing an Arvados VM using SSH keys in Windows environments using PuTTY. If you would like to use to access VM through your browser, please visit the Accessing an Arvados VM with Webshell page. If you are using a Unix-like environment (Linux, macOS, Cygwin, or Windows Subsystem for Linux), please visit the Accessing an Arvados VM with SSH – Unix Environments page.
Arvados requires a public SSH key in order to securely log in to an Arvados VM instance, or to access an Arvados Git repository. The three sections below help you get started:
(Note: If you are using the SSH client that comes with Cygwin or Windows Subsystem for Linux (WSL) please use instructions found in the Accessing an Arvados VM with SSH – Unix Environments page.)
We will be using PuTTY to connect to Arvados. PuTTY is a free (MIT-licensed) Win32 Telnet and SSH client. PuTTY includes all the tools a Windows user needs to create private keys and make SSH connections to your virtual machines in the Arvados Cloud.
You can download PuTTY from its Web site. Note that you should download the installer or .zip file with all of the PuTTY tools (PuTTYtel is not required).
If you downloaded the zip file, extract it to the location you wish to install the PuTTY applications. This document assumes that you installed PuTTY in the default directory under
C:\Program Files\ or
C:\Program Files (x86)\ (if you are using a 64 bit operating system).
C:\Program Files (x86)\(if you are using a 64 bit operating system).
C:\Program Files\PuTTY\, add the following to the end of PATH:
C:\Program Files (x86)\PuTTY\, add the following to the end of PATH:
;C:\Program Files (x86)\PuTTY
Pageant is a PuTTY utility that manages your private keys so is not necessary to enter your private key passphrase every time you make a new SSH connection.
You may now proceed to adding your key to the Arvados Workbench.
In the Workbench top navigation menu, click on the dropdown menu icon to access the user settings menu and click on the menu item SSH keys to go to the SSH keys page. Click on the + Add new SSH key button in this page. This will open a popup as shown in this screenshot:
Paste your public key into the text area labeled Public Key, and click on the Submit button. You are now ready to log into an Arvados VM.
To see a list of virtual machines that you have access to, click on the dropdown menu icon in the upper right corner of the top navigation menu to access the user settings menu, then click on the menu item Virtual machines to go to the Virtual machines page.
This page lists the virtual machines you can access. The Host name column lists the name of each available VM. The Login name column lists your login name on that VM. The Command line column provides a sample
ssh command line.
At the bottom of the page there may be additional instructions for connecting your specific Arvados instance. If so, follow your site-specific instructions. If there are no site-specific instructions, you can probably connect directly with
The following are generic instructions. In the examples the login will be you and the hostname will be shell.ClusterID.example.com and . Replace these with your login name and hostname as appropriate.
plink -P 2222 email@example.com %host
Note: We recommend you do not delete the “Default” Saved Session.
Note: If you see a hung PuTTY terminal window with no further action: open a new Command Prompt window using the Windows → Start menu and type
plink -P 2222 firstname.lastname@example.org shell in it. Please make sure to replace shell with the hostname listed in the Virtual Machines page. Hit enter and type y when prompted to cache the session state. Go back and start PuTTY session using the start menu button.
You should now be able to log into the Arvados VM and check your environment.
The content of this documentation is licensed under the
Commons Attribution-Share Alike 3.0 United States licence.
Code samples in this documentation are licensed under the Apache License, Version 2.0.