doc/user/getting_started/ssh-access-windows.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: userguide
   4 title: Accessing an Arvados VM with SSH - Windows Environments
   5 ...
   6 {% comment %}
   7 Copyright (C) The Arvados Authors. All rights reserved.
   8
   9 SPDX-License-Identifier: CC-BY-SA-3.0
  10 {% endcomment %}
  11
  12 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":vm-login-with-webshell.html 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":ssh-access-unix.html page.
  13
  14 {% include 'ssh_intro' %}
  15
  16 h1(#gettingkey). Getting your SSH key
  17
  18 (Note: If you are using the SSH client that comes with "Cygwin":http://cygwin.com or Windows Subsystem for Linux (WSL) please use instructions found in the "Accessing an Arvados VM with SSH - Unix Environments":ssh-access-unix.html page.)
  19
  20 We will be using PuTTY to connect to Arvados. "PuTTY":http://www.chiark.greenend.org.uk/~sgtatham/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.
  21
  22 You can "download PuTTY from its Web site":http://www.chiark.greenend.org.uk/~sgtatham/putty/.  Note that you should download the installer or .zip file with all of the PuTTY tools (PuTTYtel is not required).
  23
  24 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).
  25
  26 h3. Step 1 - Adding PuTTY to the PATH
  27
  28 # After downloading PuTTY and installing it, you should have a PuTTY folder in @C:\Program Files\@ or @C:\Program Files (x86)\@ (if you are using a 64 bit operating system).
  29 # Open the Control Panel.
  30 # Select _Advanced System Settings_, and choose _Environment Variables_.
  31 If you are using newer systems like Windows 10, you may use the following to open _Advanced System Settings_. Open Control Panel. Click on _System and Security_. Click on _System_. Click on _Advanced system settings_ and choose _Environment Variables..._
  32 # Under system variables, find and edit @PATH@.
  33 # If you installed PuTTY in @C:\Program Files\PuTTY\@, add the following to the end of PATH:
  34 <code>;C:\Program Files\PuTTY</code>
  35 If you installed PuTTY in @C:\Program Files (x86)\PuTTY\@, add the following to the end of PATH:
  36 <code>;C:\Program Files (x86)\PuTTY</code>
  37 # Click through the OKs to close all the dialogs you’ve opened.
  38
  39 h3. Step 2 - Creating a Public Key
  40
  41 # Start PuTTYgen from the Start Menu or the folder where it was installed.
  42 # At the bottom of the window, make sure the ‘Number of bits in a generated key’ field is set to 4096.
  43 # Click Generate and follow the instructions to generate a key.
  44 # Click the _Save public key_ button.
  45 # Click the _Save private key_ button (we recommend using a strong passphrase).
  46 # Select the text of the Public Key and copy it to the clipboard.
  47
  48 h3. Step 3 - Set up Pageant
  49
  50 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.
  51
  52 # Start Pageant from the Start Menu or the folder where it was installed.
  53 # Pageant will now be running in the system tray. Click the Pageant icon to configure.
  54 # Choose _Add Key_ and add the private key which you created in the previous step.
  55
  56 {% include 'ssh_addkey' %}
  57
  58 h3. Initial configuration
  59
  60 h4. Connecting directly
  61
  62 # Open PuTTY from the Start Menu.
  63 # On the Session screen set the Host Name (or IP address) to “shell.ClusterID.example.com”, which is the hostname listed in the _Virtual Machines_ page.
  64 # On the Session screen set the Port to “22”.
  65 # On the Connection %(rarr)&rarr;% Data screen set the Auto-login username to the username listed in the *Login name* column on the Arvados Workbench Virtual machines_ page.
  66 # Return to the Session screen. In the Saved Sessions box, enter a name for this configuration and click Save.
  67
  68 h4. Connecting through switchyard
  69
  70 # Open PuTTY from the Start Menu.
  71 # On the Session screen set the Host Name (or IP address) to “shell”, which is the hostname listed in the _Virtual Machines_ page.
  72 # On the Session screen set the Port to “22”.
  73 # On the Connection %(rarr)&rarr;% Data screen set the Auto-login username to the username listed in the *Login name* column on the Arvados Workbench Virtual machines_ page.
  74 # On the Connection %(rarr)&rarr;% Proxy screen set the Proxy Type to “Local”.
  75 # On the Connection %(rarr)&rarr;% Proxy screen in the “Telnet command, or local proxy command” box enter:
  76 <code>plink -P 2222 turnout@switchyard.{{ site.arvados_api_host }} %host</code>
  77 Make sure there is no newline at the end of the text entry.
  78 # Return to the Session screen. In the Saved Sessions box, enter a name for this configuration and click Save.
  79
  80 _Note: We recommend you do not delete the “Default” Saved Session._
  81
  82 h3. Connecting to the VM
  83
  84 # Open PuTTY from the Start Menu.
  85 # Click on the Saved Session name you created in the previous section.
  86 # Click Load to load those saved session settings.
  87 # Click Open to open the SSH window at the command prompt. You will now be logged into your virtual machine.
  88
  89 _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 <code>plink -P 2222 turnout@switchyard.{{ site.arvados_api_host }} shell</code> 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.
  90
  91 You should now be able to log into the Arvados VM and "check your environment.":check-environment.html