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

   1 ---
   2 layout: default
   3 navsection: userguide
   4 title: Accessing an Arvados VM over ssh
   5 ...
   6
   7 Arvados requires a public @ssh@ key in order to securely log in to an Arvados VM instance, or to access an Arvados @git@ repository.
   8
   9 This document is divided up into three sections.
  10
  11 # "Getting your ssh key":#gettingkey
  12 # "Adding your key to Arvados Workbench":#workbench
  13 # "Using ssh to log into an Arvados VM instance":#login
  14
  15 h1(#gettingkey). Getting your ssh key
  16
  17 # "Using Unix ssh":#unix (Linux, OS X, Cygwin)
  18 # "Using PuTTY":#windows (Windows)
  19
  20 h2(#unix). Unix: Using ssh-keygen
  21
  22 Start by opening a terminal window.  Check if you have an existing public key:
  23
  24 notextile. <pre><code>$ <span class="userinput">ls ~/.ssh/id_rsa.pub</span></code></pre>
  25
  26 If the file @id_rsa.pub@ exists, then you may use your existing key.  Copy the contents of @~/.ssh/id_rsa.pub@ onto the clipboard (this is your public key).  Proceed to "adding your key to the Arvados Workbench.":#workbench
  27
  28 If there is no file @~/.ssh/id_rsa.pub@, you must generate a new key.  Use @ssh-keygen@ to do this:
  29
  30 <notextile>
  31 <pre><code>$ <span class="userinput">ssh-keygen -t rsa -C "you@example.com"</span>
  32 Generating public/private rsa key pair.
  33 Enter file in which to save the key (/home/example/.ssh/id_rsa):
  34 Enter passphrase (empty for no passphrase):
  35 Enter same passphrase again:
  36 </code></pre>
  37 </notextile>
  38
  39 * @-t@ specifies the key type (must be "rsa")
  40 * @-C@ specifies a comment (to remember which account the key is associated with)
  41
  42 We strongly recommend that you protect your key with a passphrase.  This means that when the key is used, you will be required to enter the passphrase.  However, unlike logging into remote system using a password, the passphrase is never sent over the network, it is only used to decrypt your private key.
  43
  44 Display the contents of @~/.ssh/id_rsa.pub@ (this is your public key) using @cat@ and then copy it onto the clipboard:
  45
  46 <notextile>
  47 <pre><code>$ <span class="userinput">cat ~/.ssh/id_rsa.pub</span>
  48 ssh-rsa AAAAB3NzaC1ycEDoNotUseExampleKeyDoNotUseExampleKeyDoNotUseExampleKeyDoNotUse9lmzkpBq983bQradKGT3LuKda9QOGe8MatI6wzSrJLSGhHm3hk6D8OWWUG4SneuCtKIk2bH0pgBj1G29+uzDIez90WzfCTZKbz4RcVQmPkowSSUAQDwb0ffwvRDhCgcJ1loT1wQAJzqJmljQ7xEYaCOIMqnfYE0lX7B3MSvCV6Ie2rWL33YecLp48LVtqiCOZU4XRyO8RSDFRFLVW+mjkLirwtDHZCRtORScaIEN0jw51p+T+9X5iA9QH/Mn+xlgk7fCgH+JtpBj808N/Qds2Gpff+Kb6ulUrVVfMK6L you@example.com
  49 </code></pre>
  50 </notextile>
  51
  52 Now you can set up @ssh-agent@ (next) or proceed to "adding your key to the Arvados Workbench.":#workbench
  53
  54 h3. Setting up ssh-agent (recommended)
  55
  56 If you find you are entering your passphrase frequently, you can use @ssh-agent@ to manage your credentials.  Use @ssh-add -l@ to test if you already have ssh-agent running:
  57
  58 notextile. <pre><code>$ <span class="userinput">ssh-add -l</span></code></pre>
  59
  60 If you get the error "Could not open a connection to your authentication agent" you will need to run @ssh-agent@ with the following command:
  61
  62 notextile. <pre><code>$ <span class="userinput">eval $(ssh-agent -s)</span></code></pre>
  63
  64 * @ssh-agent -s@ prints out values for environment variables SSH_AUTH_SOCK and SSH_AGENT_PID and then runs in the background.  Using "eval" on the output as shown here causes those variables to be set in the current shell environment so that subsequent calls to @ssh@ can discover how to access the @ssh-agent@ daemon.
  65
  66 After running @ssh-agent@, or if @ssh-add -l@ prints "The agent has no identities", then you will need to add your key using the following command.  The passphrase to decrypt the key is the same used to protect the key when it was created with @ssh-keygen@:
  67
  68 <notextile>
  69 <pre><code>$ <span class="userinput">ssh-add</span>
  70 Enter passphrase for /home/example/.ssh/id_rsa:
  71 Identity added: /home/example/.ssh/id_rsa (/home/example/.ssh/id_rsa)
  72 </code></pre>
  73 </notextile>
  74
  75 When everything is set up, @ssh-add -l@ should yield output that looks something like this:
  76
  77 <notextile>
  78 <pre><code>$ <span class="userinput">ssh-add -l</span>
  79 2048 eb:fa:15:f2:44:26:95:58:37:37:f4:aa:ff:ee:c2:85 you@example.com (RSA)
  80 </code></pre>
  81 </notextile>
  82
  83 You may now proceed to "adding your key to the Arvados Workbench.":#workbench
  84
  85 h2(#windows). Windows: Using PuTTY
  86
  87 (Note: if you are using the @ssh@ client that comes with "Cygwin":http://cygwin.com you should follow the "Unix":#unix instructions).
  88
  89 "PuTTY":http://www.putty.org/ 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.
  90
  91 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.
  92
  93 You may download putty from "http://www.putty.org/":http://www.putty.org/ .
  94
  95 Note that you should download the installer or .zip file with all of the PuTTY tools (PuTTYtel is not required).
  96
  97 h3. Step 1 - Adding PuTTY to the PATH
  98
  99 # 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).  If you downloaded a zip file, extract it to the location you wish to install the PuTTY applications.
 100 # Open the Control Panel.
 101 # Select _Advanced System Settings_, and choose _Environment Variables_.
 102 # Under system variables, find and edit @PATH@.
 103 # Add the following to the end of PATH (make sure to include semi colon and quotation marks):
 104 <code>;\"C:\Program Files (x86)\PuTTY\"</code>
 105 # Click through the OKs to close all the dialogs you’ve opened.
 106
 107 h3. Step 2 - Creating a Public Key
 108
 109 # Start PuTTYgen from the Start Menu or the folder where it was installed.
 110 # At the bottom of the window, make sure the ‘Number of bits in a generated key’ field is set to 4096.
 111 # Click Generate and follow the instructions to generate a key.
 112 # Click to save the Public Key.
 113 # Click to save the Private Key (we recommend using a strong passphrase) .
 114 # Select the text of the Public Key and copy it to the clipboard.
 115
 116 h3. Step 3 - Set up Pageant
 117
 118 Note: Pageant is a PuTTY utility that manages your private keys so is not necessary to enter your private key passphrase every time you need to make a new ssh connection.
 119
 120 # Start Pageant from the Start Menu or the folder where it was installed.
 121 # Pageant will now be running in the system tray. Click the Pageant icon to configure.
 122 # Choose _Add Key_ and add the private key which you created in the previous step.
 123
 124 You are now ready to proceed to "adding your key to the Arvados Workbench":#workbench .
 125
 126 _Note: We recommend you do not delete the “Default” Saved Session._
 127
 128 h1(#workbench). Adding your key to Arvados Workbench
 129
 130 h3. From the workbench dashboard
 131
 132 If you have no @ssh@ keys registered, there should be a notification asking you to provide your @ssh@ public key.  On the Workbench dashboard (in this guide, this is "https://{{ site.arvados_workbench_host }}/":https://{{ site.arvados_workbench_host }}/ ), look for the envelope icon <span class="glyphicon glyphicon-envelope"></span> <span class="badge badge-alert">1</span> in upper right corner (the number indicates there are new notifications).  Click on this icon and a dropdown menu should appear with a message asking you to add your public key.  Paste your public key into the text area provided and click on the check button to submit the key.  You are now ready to "log into an Arvados VM":#login.
 133
 134 h3. Alternate way to add ssh keys
 135
 136 If you want to add additional @ssh@ keys, click on the user icon <span class="glyphicon glyphicon-user"></span> in the upper right corner to access the user settings menu, and click on the menu item _Manage ssh keys_ to go to the Authorized keys page.
 137
 138 On _Authorized keys_ page, the click on the button <span class="btn btn-primary disabled">Add a new authorized key</span> in the upper right corner.
 139
 140 The page will reload with a new row of information.  Under the *public_key* column heading, click on the cell +none+ .  This will open an editing popup as shown in this screenshot:
 141
 142 !{{ site.baseurl }}/images/ssh-adding-public-key.png!
 143
 144 Paste the public key from the previous section into the popup text box and click on the check mark to save it.  This should refresh the page with the public key that you just added now listed under the *public_key* column.  You are now ready to "log into an Arvados VM":#login.
 145
 146 h1(#login). Using ssh to log into an Arvados VM
 147
 148 To see a list of virtual machines that you have access to and determine the name and login information, click on Compute %(rarr)&rarr;% Virtual machines.  Once on the "virtual machines" page, The *hostname* columns lists the name of each available VM.  The *logins* column will have a value in the form of @["you"]@.  Ignore the square brackets and quotes to get your login name.  In this guide the hostname will be _shell_ and the login will be _you_.  Replace these with your hostname and login as appropriate.
 149
 150 This section consists of two sets of instructions, depending on whether you will be logging in using a "Unix":#unixvm (Linux, OS X, Cygwin) or "Windows":#windowsvm client.
 151
 152 h2(#unixvm). Logging in using command line ssh (Unix)
 153
 154 h3. Connecting to the VM
 155
 156 Use the following command to connect to the "shell" VM instance as "you".  Replace *<code>you@shell</code>* at the end of the following command with your *login* and *hostname* from Workbench:
 157
 158 notextile. <pre><code>$ <span class="userinput">ssh -o "ProxyCommand ssh -a -x -p2222 turnout@switchyard.{{ site.arvados_api_host }} shell" -A -x <b>you@shell</b></span></code></pre>
 159
 160 There are several things going on here:
 161
 162 The VMs typically have addresses that are not globally routable, so you cannot log in directly.  Instead, you log into a "switchyard" server and then tell the switchyard which VM you want to connect to.
 163
 164 * @-o "ProxyCommand ..."@ option instructs ssh to run the specified command and then tunnel your ssh connection over the proxy.
 165 * @-a@ tells ssh not to forward your ssh-agent credentials to the switchyard
 166 * @-x@ tells ssh not to forward your X session to the switchyard
 167 * @-p2222@ specifies that the switchyard is running on non-standard port 2222
 168 * <code>turnout@switchyard.{{ site.arvados_api_host }}</code> specifies the user (@turnout@) and hostname (@switchyard.{{ site.arvados_api_host }}@) of the switchboard server that will proxy our connection to the VM.
 169 * @shell@ is the name of the VM that we want to connect to.  This is sent to the switchyard server as if it were an ssh command, and the switchyard server connects to the VM on our behalf.
 170 * After the ProxyCommand section, the @-x@ must be repeated because it applies to the connection to VM instead of the switchyard.
 171 * @-A@ specifies that we want to forward access to @ssh-agent@ to the VM.
 172 * Finally, *<code>you@shell</code>* specifies your username and repeats the hostname of the VM.  The username can be found in the *logins* column in the VMs Workbench page, discussed above.
 173
 174 You should now be able to log into the Arvados VM and "check your environment.":check-environment.html
 175
 176 h3. Configuration (recommended)
 177
 178 Since the above command line is cumbersome, it can be greatly simplfied by adding the following section your @~/.ssh/config@ file:
 179
 180 <notextile>
 181 <pre><code class="userinput">Host *.arvados
 182   ProxyCommand ssh -a -x -p2222 turnout@switchyard.{{ site.arvados_api_host }} $SSH_PROXY_FLAGS %h
 183   User <b>you</b>
 184   ForwardAgent yes
 185   ForwardX11 no
 186 </code></pre>
 187 </notextile>
 188
 189 This will recognize any host ending in ".arvados" and automatically apply the proxy, user and forwarding settings from the configuration file, allowing you to log in with a much simpler command:
 190
 191 notextile. <pre><code>$ <span class="userinput">ssh <b>shell</b>.arvados</span></code></pre>
 192
 193 h2(#windowsvm). Logging in using PuTTY (Windows)
 194
 195 h3. Initial configuration
 196
 197 # Open PuTTY from the Start Menu.
 198 # On the Session screen set the Host Name (or IP address) to “shell”.
 199 # On the Session screen set the Port to “22”.
 200 # On the Connection %(rarr)&rarr;% Data screen set the Auto-login username to the username listed in the *logins* column on the Arvados Workbench _Access %(rarr)&rarr;% VMs_ page.
 201 # On the Connection %(rarr)&rarr;% Proxy screen set the Proxy Type to “Local”.
 202 # On the Connection %(rarr)&rarr;% Proxy screen in the “Telnet command, or local proxy command” box enter:
 203 <code>plink -P 2222 turnout@switchyard.qr1hi.arvadosapi.com %host</code>
 204 Make sure there is no newline at the end of the text entry.
 205 # Return to the Session screen. In the Saved Sessions box, enter a name for this configuration and hit Save.
 206
 207 h3. Connecting to the VM
 208
 209 # Open PuTTY
 210 # Click on the Saved Session name you created in the previous section.
 211 # Click Load to load those saved session settings.
 212 # Click Open and that will open the SSH window at the command prompt. You will now be logged in to your virtual machine.
 213
 214 You should now be able to log into the Arvados VM and "check your environment.":check-environment.html