doc/install/install-compute-node.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: installguide
   4 title: Install a compute node
   5 ...
   6
   7 h2. Install dependencies
   8
   9 First, "add the appropriate package repository for your distribution":{{ site.baseurl }}/install/install-manual-prerequisites.html#repos.
  10
  11 {% include 'note_python27_sc' %}
  12
  13 On Debian-based systems:
  14
  15 <notextile>
  16 <pre><code>~$ <span class="userinput">sudo apt-get install perl python-virtualenv fuse python-arvados-python-client python-arvados-fuse crunchstat arvados-docker-cleaner iptables ca-certificates</span>
  17 </code></pre>
  18 </notextile>
  19
  20 On Red Hat-based systems:
  21
  22 <notextile>
  23 <pre><code>~$ <span class="userinput">sudo yum install perl python27-python-virtualenv fuse python27-python-arvados-python-client python27-python-arvados-fuse crunchstat arvados-docker-cleaner iptables ca-certificates</span>
  24 </code></pre>
  25 </notextile>
  26
  27 h2. Install Docker
  28
  29 Compute nodes must have Docker installed to run jobs inside containers.  This requires a relatively recent version of Linux (at least upstream version 3.10, or a distribution version with the appropriate patches backported).  Follow the "Docker Engine installation documentation":https://docs.docker.com/ for your distribution.
  30
  31 For Debian-based systems, the Arvados package repository includes a backported @docker.io@ package with a known-good version you can install.
  32
  33 h2. Configure Docker
  34
  35 Crunch runs jobs in Docker containers with relatively little configuration.  You may need to start the Docker daemon with specific options to make sure these jobs run smoothly in your environment.  This section highlights options that are useful to most installations.  Refer to the "Docker daemon reference":https://docs.docker.com/reference/commandline/daemon/ for complete information about all available options.
  36
  37 The best way to configure these options varies by distribution.
  38
  39 * If you're using our backported @docker.io@ package, you can list these options in the @DOCKER_OPTS@ setting in @/etc/default/docker.io@.
  40 * If you're using another Debian-based package, you can list these options in the @DOCKER_OPTS@ setting in @/etc/default/docker@.
  41 * On Red Hat-based distributions, you can list these options in the @other_args@ setting in @/etc/sysconfig/docker@.
  42
  43 h3. Default ulimits
  44
  45 Docker containers inherit ulimits from the Docker daemon.  However, the ulimits for a single Unix daemon may not accommodate a long-running Crunch job.  You may want to increase default limits for compute jobs by passing @--default-ulimit@ options to the Docker daemon.  For example, to allow jobs to open 10,000 files, set @--default-ulimit nofile=10000:10000@.
  46
  47 h3. DNS
  48
  49 Your containers must be able to resolve the hostname in the ARVADOS_API_HOST environment variable (provided by the Crunch dispatcher) and any hostnames returned in Keep service records.  If these names are not in public DNS records, you may need to set a DNS resolver for the containers by specifying the @--dns@ address with the IP address of an appropriate nameserver.  You may specify this option more than once to use multiple nameservers.
  50
  51 h2. Set up SLURM
  52
  53 Install SLURM following "the same process you used to install the Crunch dispatcher":install-crunch-dispatch.html#slurm.
  54
  55 h2. Copy configuration files from the dispatcher (API server)
  56
  57 The @slurm.conf@ and @/etc/munge/munge.key@ files need to be identical across the dispatcher and all compute nodes. Copy the files you created in the "Install the Crunch dispatcher":install-crunch-dispatch.html step to this compute node.
  58
  59 h2. Configure FUSE
  60
  61 Install this file as @/etc/fuse.conf@:
  62
  63 <notextile>
  64 <pre>
  65 # Set the maximum number of FUSE mounts allowed to non-root users.
  66 # The default is 1000.
  67 #
  68 #mount_max = 1000
  69
  70 # Allow non-root users to specify the 'allow_other' or 'allow_root'
  71 # mount options.
  72 #
  73 user_allow_other
  74 </pre>
  75 </notextile>
  76
  77 h2. Configure the Docker cleaner
  78
  79 The arvados-docker-cleaner program removes least recently used docker images as needed to keep disk usage below a configured limit.
  80
  81 {% include 'notebox_begin' %}
  82 This also removes all containers as soon as they exit, as if they were run with @docker run --rm@. If you need to debug or inspect containers after they stop, temporarily stop arvados-docker-cleaner or run it with @--remove-stopped-containers never@.
  83 {% include 'notebox_end' %}
  84
  85 Install runit to supervise the Docker cleaner daemon.  {% include 'install_runit' %}
  86
  87 Configure runit to run the image cleaner using a suitable quota for your compute nodes and workload:
  88
  89 <notextile>
  90 <pre><code>~$ <span class="userinput">sudo mkdir -p /etc/sv</span>
  91 ~$ <span class="userinput">cd /etc/sv</span>
  92 /etc/sv$ <span class="userinput">sudo mkdir arvados-docker-cleaner; cd arvados-docker-cleaner</span>
  93 /etc/sv/arvados-docker-cleaner$ <span class="userinput">sudo mkdir log log/main</span>
  94 /etc/sv/arvados-docker-cleaner$ <span class="userinput">sudo sh -c 'cat &gt;log/run' &lt;&lt;'EOF'
  95 #!/bin/sh
  96 exec svlogd -tt main
  97 EOF</span>
  98 /etc/sv/arvados-docker-cleaner$ <span class="userinput">sudo sh -c 'cat &gt;run' &lt;&lt;'EOF'
  99 #!/bin/sh
 100 exec python3 -m arvados_docker.cleaner --quota <b>50G</b>
 101 EOF</span>
 102 /etc/sv/arvados-docker-cleaner$ <span class="userinput">sudo chmod +x run log/run</span>
 103 /etc/sv/arvados-docker-cleaner$ <span class="userinput">sudo ln -s "$(pwd)" /etc/service/</span>
 104 </code></pre>
 105 </notextile>
 106
 107 If you are using a different daemon supervisor, or if you want to test the daemon in a terminal window, an equivalent shell command to run arvados-docker-cleaner is:
 108
 109 <notextile>
 110 <pre><code><span class="userinput">python3 -m arvados_docker.cleaner --quota <b>50G</b></span>
 111 </code></pre>
 112 </notextile>
 113
 114 h2. Add a Crunch user account
 115
 116 Create a Crunch user account, and add it to the @fuse@ and @docker@ groups so it can use those tools:
 117
 118 <notextile>
 119 <pre><code>~$ <span class="userinput">sudo useradd --groups fuse,docker crunch</span>
 120 </code></pre>
 121 </notextile>
 122
 123 The crunch user should have the same UID, GID, and home directory across all compute nodes and the dispatcher (API server).
 124
 125 h2. Tell the API server about this compute node
 126
 127 Load your API superuser token on the compute node:
 128
 129 <notextile>
 130 <pre><code>
 131 ~$ <span class="userinput">HISTIGNORE=$HISTIGNORE:'export ARVADOS_API_TOKEN=*'</span>
 132 ~$ <span class="userinput">export ARVADOS_API_TOKEN=@your-superuser-token@</span>
 133 ~$ <span class="userinput">export ARVADOS_API_HOST=@uuid_prefix.your.domain@</span>
 134 ~$ <span class="userinput">unset ARVADOS_API_HOST_INSECURE</span>
 135 </code>
 136 </pre>
 137 </notextile>
 138
 139 Then execute this script to create a compute node object, and set up a cron job to have the compute node ping the API server every five minutes:
 140
 141 <notextile>
 142 <pre><code>
 143 #!/bin/bash
 144 set -e
 145 if ! test -f /root/node.json ; then
 146     python - &lt;&lt;EOF
 147 import arvados, json, socket
 148 fqdn = socket.getfqdn()
 149 hostname, _, domain = fqdn.partition('.')
 150 node = arvados.api('v1').nodes().create(body={'hostname': hostname, 'domain': domain}).execute()
 151 with open('/root/node.json', 'w') as node_file:
 152     json.dump(node, node_file, indent=2)
 153 EOF
 154
 155     # Make sure /dev/fuse permissions are correct (the device appears after fuse is loaded)
 156     chmod 1660 /dev/fuse && chgrp fuse /dev/fuse
 157 fi
 158
 159 UUID=`grep \"uuid\" /root/node.json  |cut -f4 -d\"`
 160 PING_SECRET=`grep \"ping_secret\" /root/node.json  |cut -f4 -d\"`
 161
 162 if ! test -f /etc/cron.d/node_ping ; then
 163     echo "*/5 * * * * root /usr/bin/curl -k -d ping_secret=$PING_SECRET https://$ARVADOS_API_HOST/arvados/v1/nodes/$UUID/ping" > /etc/cron.d/node_ping
 164 fi
 165
 166 /usr/bin/curl -k -d ping_secret=$PING_SECRET https://$ARVADOS_API_HOST/arvados/v1/nodes/$UUID/ping?ping_secret=$PING_SECRET
 167 </code>
 168 </pre>
 169 </notextile>
 170
 171 And remove your token from the environment:
 172
 173 <notextile>
 174 <pre><code>
 175 ~$ <span class="userinput">unset ARVADOS_API_TOKEN</span>
 176 ~$ <span class="userinput">unset ARVADOS_API_HOST</span>
 177 </code>
 178 </pre>
 179 </notextile>