doc/install/install-shell-server.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: installguide
   4 title: Set up a shell node
   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 # "Introduction":#introduction
  13 # "Install Dependencies and SDKs":#dependencies
  14 # "Install git and curl":#install-packages
  15 # "Update Git Config":#config-git
  16 # "Create record for VM":#vm-record
  17 # "Install arvados-login-sync":#arvados-login-sync
  18 # "Confirm working installation":#confirm-working
  19
  20 h2(#introduction). Introduction
  21
  22 Arvados support for shell nodes allows you to use Arvados permissions to grant Linux shell accounts to users.
  23
  24 A shell node runs the @arvados-login-sync@ service to manage user accounts, and typically has Arvados utilities and SDKs pre-installed.  Users are allowed to log in and run arbitrary programs.  For optimal performance, the Arvados shell server should be on the same LAN as the Arvados cluster.
  25
  26 Because Arvados @config.yml@ _contains secrets_ it should *not* be present on shell nodes.
  27
  28 Shell nodes should be separate virtual machines from the VMs running other Arvados services.  You may choose to grant root access to users so that they can customize the node, for example, installing new programs.  This has security considerations depending on whether a shell node is single-user or multi-user.
  29
  30 A single-user shell node should be set up so that it only stores Arvados access tokens that belong to that user.  In that case, that user can be safely granted root access without compromising other Arvados users.
  31
  32 In the multi-user shell node case, a malicious user with @root@ access could access other user's Arvados tokens.  Users should only be given @root@ access on a multi-user shell node if you would trust them to be Arvados administrators.  Be aware that with access to the @docker@ daemon, it is trival to gain *root* access to any file on the system, so giving users @docker@ access should be considered equivalent to @root@ access.
  33
  34 h2(#dependencies). Install Dependencies and SDKs
  35
  36 # "Install Ruby and Bundler":ruby.html
  37 # "Install the Python SDK":{{site.baseurl}}/sdk/python/sdk-python.html
  38 # "Install the FUSE driver":{{site.baseurl}}/sdk/fuse/install.html
  39 # "Install the CLI":{{site.baseurl}}/sdk/cli/install.html
  40 # "Install the R SDK":{{site.baseurl}}/sdk/R/index.html (optional)
  41 # "Install Docker":install-docker.html (optional)
  42
  43 {% assign arvados_component = 'git curl' %}
  44
  45 {% include 'install_packages' %}
  46
  47 h2(#config-git). Update Git Config
  48
  49 Configure git to use the ARVADOS_API_TOKEN environment variable to authenticate to arvados-git-httpd. We use the @--system@ flag so it takes effect for all current and future user accounts. It does not affect git's behavior when connecting to other git servers.
  50
  51 <notextile>
  52 <pre>
  53 <code># <span class="userinput">git config --system 'credential.https://git.<b>ClusterID.example.com</b>/.username' none</span></code>
  54 <code># <span class="userinput">git config --system 'credential.https://git.<b>ClusterID.example.com</b>/.helper' '!cred(){ cat >/dev/null; if [ "$1" = get ]; then echo password=$ARVADOS_API_TOKEN; fi; };cred'</span></code>
  55 </pre>
  56 </notextile>
  57
  58 h2(#vm-record). Create record for VM
  59
  60 As an admin, create an Arvados virtual_machine object representing this shell server. This will return a uuid.
  61
  62 <notextile>
  63 <pre>
  64 <code>apiserver:~$ <span class="userinput">arv --format=uuid virtual_machine create --virtual-machine '{"hostname":"<b>shell.ClusterID.example.com</b>"}'</span>
  65 zzzzz-2x53u-zzzzzzzzzzzzzzz</code>
  66 </pre>
  67 </notextile>
  68
  69 h2(#arvados-login-sync). Install arvados-login-sync
  70
  71 The @arvados-login-sync@ service makes it possible for Arvados users to log in to the shell server.  It sets up login accounts, updates group membership, adds each user's SSH public keys to the @~/.ssh/authorized_keys@ file, and adds an Arvados token to @~/.config/arvados/settings.conf@ .
  72
  73 Install the @arvados-login-sync@ program from RubyGems.
  74
  75 <notextile>
  76 <pre>
  77 <code>shellserver:# <span class="userinput">gem install arvados-login-sync</span></code>
  78 </pre>
  79 </notextile>
  80
  81 h2(#arvados-login-sync). Run arvados-login-sync periodically
  82
  83 Create a cron job to run the @arvados-login-sync@ program every 2 minutes.  This will synchronize user accounts.
  84
  85 If this is a single-user shell node, then @ARVADOS_API_TOKEN@ should be a token for that user.  See "Create a token for a user":{{site.baseurl}}/admin/user-management-cli.html#create-token .
  86
  87 If this is a multi-user shell node, then @ARVADOS_API_TOKEN@ should be an administrator token such as the @SystemRootToken@.  See discussion in the "introduction":#introduction about security on multi-user shell nodes.
  88
  89 Set @ARVADOS_VIRTUAL_MACHINE_UUID@ to the UUID from "Create record for VM":#vm-record
  90
  91 h3. Standalone cluster
  92
  93 <notextile>
  94 <pre>
  95 <code>shellserver:# <span class="userinput">umask 0700; tee /etc/cron.d/arvados-login-sync &lt;&lt;EOF
  96 ARVADOS_API_HOST="<strong>ClusterID.example.com</strong>"
  97 ARVADOS_API_TOKEN="<strong>xxxxxxxxxxxxxxxxx</strong>"
  98 ARVADOS_VIRTUAL_MACHINE_UUID="<strong>zzzzz-2x53u-zzzzzzzzzzzzzzz</strong>"
  99 */2 * * * * root arvados-login-sync
 100 EOF</span></code>
 101 </pre>
 102 </notextile>
 103
 104 h3. Part of a LoginCluster federation
 105
 106 If the cluster is part of a "federation with centralized user management":../admin/federation.html#LoginCluster , the login sync script needs to be given an admin token from the login cluster.
 107
 108 <notextile>
 109 <pre>
 110 <code>shellserver:# <span class="userinput">umask 0700; tee /etc/cron.d/arvados-login-sync &lt;&lt;EOF
 111 ARVADOS_API_HOST="<strong>ClusterID.example.com</strong>"
 112 ARVADOS_API_TOKEN="<strong>yyyloginclusteradmintokenyyyy</strong>"
 113 ARVADOS_VIRTUAL_MACHINE_UUID="<strong>zzzzz-2x53u-zzzzzzzzzzzzzzz</strong>"
 114 */2 * * * * root arvados-login-sync
 115 EOF</span></code>
 116 </pre>
 117 </notextile>
 118
 119
 120 h2(#confirm-working). Confirm working installation
 121
 122 A user should be able to log in to the shell server when the following conditions are satisfied:
 123
 124 # As an admin user, you have given the user permission to log in using the Workbench &rarr; Admin menu &rarr; "Users" item &rarr; "Show" button &rarr; "Admin" tab &rarr; "Setup account" button.
 125 # The cron job has run.
 126
 127 In order to log in via SSH, the user must also upload an SSH public key.  Alternately, if configured, users can log in using "Webshell":install-webshell.html .
 128
 129 See also "how to add a VM login permission link at the command line":../admin/user-management-cli.html