Merge branch '6838-docker-path' closes #6838
[arvados.git] / 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 On Debian-based systems:
12
13 <notextile>
14 <pre><code>~$ <span class="userinput">sudo apt-get install perl python-virtualenv fuse python-arvados-python-client python-arvados-fuse crunchstat iptables ca-certificates</span>
15 </code></pre>
16 </notextile>
17
18 On Red Hat-based systems:
19
20 <notextile>
21 <pre><code>~$ <span class="userinput">sudo yum install perl python27-python-virtualenv fuse python27-python-arvados-python-client python27-python-arvados-fuse crunchstat iptables ca-certificates</span>
22 </code></pre>
23 </notextile>
24
25 {% include 'note_python27_sc' %}
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":{{ site.baseurl }}/install/install-crunch-dispatch.html#slurm.
54
55 h2. Copy configuration files from the dispatcher (API server)
56
57 The @/etc/slurm-llnl/slurm.conf@ and @/etc/munge/munge.key@ files need to be identicaly across the dispatcher and all compute nodes. Copy the files you created in the "Install the Crunch dispatcher":{{site.baseurl}} 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. Crunch user account
78
79 Create a Crunch user account, and add it to the @fuse@ and @docker@ groups so it can use those tools:
80
81 <notextile>
82 <pre><code>~$ <span class="userinput">sudo useradd --groups fuse,docker crunch</span>
83 </code></pre>
84 </notextile>
85
86 The crunch user should have the same UID, GID, and home directory across all compute nodes and the dispatcher (API server).
87
88 h2. Tell the API server about this compute node
89
90 Load your API superuser token on the compute node:
91
92 <notextile>
93 <pre><code>
94 ~$ <span class="userinput">HISTIGNORE=$HISTIGNORE:'export ARVADOS_API_TOKEN=*'</span>
95 ~$ <span class="userinput">export ARVADOS_API_TOKEN=@your-superuser-token@</span>
96 ~$ <span class="userinput">export ARVADOS_API_HOST=@uuid_prefix.your.domain@</span>
97 ~$ <span class="userinput">unset ARVADOS_API_HOST_INSECURE</span>
98 </code>
99 </pre>
100 </notextile>
101
102 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:
103
104 <notextile>
105 <pre><code>
106 #!/bin/bash
107 set -e
108 if ! test -f /root/node.json ; then
109     python - &lt;&lt;EOF
110 import arvados, json, socket
111 node = arvados.api('v1').nodes().create(body={'hostname': socket.gethostname()}).execute()
112 with open('/root/node.json', 'w') as node_file:
113     json.dump(node, node_file, indent=2)
114 EOF
115
116     # Make sure /dev/fuse permissions are correct (the device appears after fuse is loaded)
117     chmod 1660 /dev/fuse && chgrp fuse /dev/fuse
118 fi
119
120 UUID=`grep \"uuid\" /root/node.json  |cut -f4 -d\"`
121 PING_SECRET=`grep \"ping_secret\" /root/node.json  |cut -f4 -d\"`
122
123 if ! test -f /etc/cron.d/node_ping ; then
124     echo "*/5 * * * * root /usr/bin/curl -k -d ping_secret=$PING_SECRET https://api/arvados/v1/nodes/$UUID/ping" > /etc/cron.d/node_ping
125 fi
126
127 /usr/bin/curl -k -d ping_secret=$PING_SECRET https://api/arvados/v1/nodes/$UUID/ping?ping_secret=$PING_SECRET
128 </code>
129 </pre>
130 </notextile>
131
132 And remove your token from the environment:
133
134 <notextile>
135 <pre><code>
136 ~$ <span class="userinput">unset ARVADOS_API_TOKEN</span>
137 ~$ <span class="userinput">unset ARVADOS_API_HOST</span>
138 </code>
139 </pre>
140 </notextile>
141