doc/user/ssh-access.md

   1 ---
   2 layout: default
   3 navsection: userguide
   4 title: Setting up SSH access
   5 navorder: 2
   6 ---
   7
   8 # Setting up SSH access
   9
  10 Arvados uses SSH public key authentication for two things:
  11
  12 * logging in to a VM, and
  13 * pushing code to a git repository.
  14
  15 ### Generate a public/private SSH key pair
  16
  17 If you don't already have an SSH key pair (or you don't know whether
  18 you do), there are lots of tutorials out there to help you get
  19 started:
  20
  21 * [github SSH key
  22 tutorial](https://www.google.com/search?q=github+ssh+key+help)
  23
  24 ### Associate your SSH public key with your Arvados Workbench account
  25
  26 Go to the `Keys` page in Arvados Workbench (under the `Access` tab) and click the
  27
  28 <p style="margin-left: 4em"><span class="btn btn-primary">Add a new authorized key</span></p>
  29
  30 button. Then click on 'none' in the public_key column, and copy and paste your public key:
  31
  32 ![Screen shot of the ssh public key box]({{ site.baseurl }}/images/ssh-adding-public-key.png)
  33
  34 Click on the checkmark button to save your public key.
  35
  36 ### Set up your ssh client (Unix-like systems only)
  37
  38 {% include notebox-begin.html %}
  39
  40 If you are using an Arvados site other than {{ site.arvados_api_host }}, replace "{{ site.arvados_api_host }}" with the appropriate Arvados API hostname in these examples.
  41
  42 {% include notebox-end.html %}
  43
  44 On your workstation, add the following section to your `~/.ssh/config`
  45 file:
  46
  47     Host *.arvados
  48       ProxyCommand ssh -p2222 turnout@switchyard.{{ site.arvados_api_host }} -x -a $SSH_PROXY_FLAGS %h
  49
  50 If you have access to an account `foo` on a VM called `blurfl` then
  51 you can log in like this:
  52
  53     ssh foo@blurfl.arvados
  54
  55 If you want to shorten this and you always/usually have access to the
  56 `foo` account on VMs, you can add a section like this to
  57 `~/.ssh/config`:
  58
  59     Host *.a
  60       ProxyCommand ssh -p2222 turnout@switchyard.{{ site.arvados_api_host }} -x -a $SSH_PROXY_FLAGS %h
  61       User foo
  62
  63 Then you can log in to the `blurfl` VM as `foo` like this:
  64
  65     ssh blurfl.a
  66
  67 Arvados Workbench will show you a list of VMs you have access to and
  68 what your account name is for each one: click "VMs" in the "Access"
  69 menu.
  70
  71 ### Windows: Setup instructions for PuTTY
  72
  73 PuTTY is a free (MIT-licensed) Win32 Telnet and SSH client. PuTTy includes all the tools a windows user needs to set up Private Keys and to set up and use SSH connections to your virtual machines in the Arvados Cloud.
  74
  75 You can use PuTTY to create public/private keys, which are how you’ll ensure that that access to Arvados cloud is secure. You can also use PuTTY as an SSH client to access your virtual machine in an Arvados cloud and work with the Arvados Command Line Interface (CLI) client.
  76
  77 PuTTY is an open source project and you download it [here](http://www.putty.org/).
  78
  79 Arvados uses Public-key encryption to secure access to your virtual machines in the Arvados cloud. this is a very standard approach. It’s secure, and easy to use.
  80
  81 (Make sure to download the .zip file containing all the binaries, not each one individually)
  82
  83 __Step 1 - Adding PuTTY to the PATH__
  84
  85 1. After downloading PuTTY and unzipping it, you should have a PuTTY folder in C:\Program Files (x86)\ . If the folder is somewhere else, you can change the PATH in step X or move the folder to that directory.
  86
  87 2. In the Start menu, right click Windows and select Properties
  88
  89 3. Select Advanced System Settings, and choose Environment Variables
  90
  91 4. Under system variables, find and edit Path.
  92
  93 5. Add the following to the end of Path (make sure to include semi colon and quotation marks):
  94
  95         ;\"C:\Program Files (x86)\PuTTY\"
  96
  97 6. Click through the OKs to close all the dialogs you’ve opened
  98
  99 __Step 2 - Creating a Public Key__
 100
 101 1. Open PuTTYgen from the Start Menu
 102
 103 2. At the bottom of the window, make sure the ‘Number of bits in a generated key’ field is set to 4096
 104
 105 3. Click Generate and follow the instructions to generate a key
 106
 107 4. Click to save the Public Key
 108
 109 5. Click to save the Private Key (we recommend using a strong passphrase)
 110
 111 6. Select the Public Key text in the box and copy (for next step)
 112
 113 Now your key is successfully generated.
 114
 115 __Step 3 - Load Your Public Key in to your Arvados Account through Workbench__
 116
 117 1. Open Workbench on the cloud where you have an arvados account
 118
 119 2. Go to Access > Keys in the menu
 120
 121 3. Click to create a new key
 122
 123 4. In the last column “public key” click on the text that says “none” and paste the public key from PuTTYgen into the box.
 124
 125 Your public key is now registered with the Arvados cluster.
 126
 127 __Step 4 - Set up Pageant__
 128
 129 1. Start Pageant from the PuTTY folder in the start menu
 130
 131 2. Pageant will now be running in the system tray. Click the icon to configure.
 132
 133 3. Choose Add Key and add the private which corresponds with the public key you loaded in your Arvados account through work bench.
 134
 135 Pageant is now configured. It will run in the background as a system service.
 136
 137 Note: Pageant is a PuTTY utility that manages private keys which makes repeatedly logging in through SSH less of a hassle.
 138
 139 __Step 5 - Set up PuTTY__
 140
 141 1. Open PuTTY from the Start Menu
 142
 143 2. On the Session screen set the Host Name (or IP address) to “shell”
 144
 145 3. On the Session screen set the Port to “22”
 146
 147 4. On the Connection > Data screen set the Auto-login username to your VM’s Login,. You can find your login name in Workbench under Access > VMs last column on the table.
 148
 149 5. On the Connection > Proxy screen set the Proxy Type to “Local”
 150
 151 6. On the Connection > Proxy screen in the “Telnet command, or local proxy command” box enter “plink -P 2222 turnout@switchyard.qr1hi.arvadosapi.com %host”. Make sure you remove the “\n” from the end of the line.
 152
 153 7. Return to the Session screen. In the Saved Sessions box, enter a name for this configuration and hit Save.
 154
 155
 156 __Step 6 - Launch an SSH Session__
 157
 158 1. Open PuTTY
 159
 160 2. Click on the Saved Session name you created in Step 5
 161
 162 3. Click Load to load those saved session settings
 163
 164 4. Click Open and that will open the SSH window at the command prompt. You will now be logged in to your virtual machine.
 165
 166 _Note: We recommend you do not delete the “Default” Saved Session._
 167