8784: Fix test for latest firefox.
[arvados.git] / doc / install / crunch2-slurm / install-slurm.html.textile.liquid
1 ---
2 layout: default
3 navsection: installguide
4 title: Set up SLURM
5 ...
6
7 h2(#slurm). Set up SLURM
8
9 On the API server, install SLURM and munge, and generate a munge key.
10
11 On Debian-based systems:
12
13 <notextile>
14 <pre><code>~$ <span class="userinput">sudo /usr/bin/apt-get install slurm-llnl munge</span>
15 ~$ <span class="userinput">sudo /usr/sbin/create-munge-key</span>
16 </code></pre>
17 </notextile>
18
19 On Red Hat-based systems:
20
21 <notextile>
22 <pre><code>~$ <span class="userinput">sudo yum install slurm munge slurm-munge</span>
23 </code></pre>
24 </notextile>
25
26 Now we need to give SLURM a configuration file.  On Debian-based systems, this is installed at @/etc/slurm-llnl/slurm.conf@.  On Red Hat-based systems, this is installed at @/etc/slurm/slurm.conf@.  Here's an example @slurm.conf@:
27
28 <notextile>
29 <pre>
30 ControlMachine=uuid_prefix.your.domain
31 SlurmctldPort=6817
32 SlurmdPort=6818
33 AuthType=auth/munge
34 StateSaveLocation=/tmp
35 SlurmdSpoolDir=/tmp/slurmd
36 SwitchType=switch/none
37 MpiDefault=none
38 SlurmctldPidFile=/var/run/slurmctld.pid
39 SlurmdPidFile=/var/run/slurmd.pid
40 ProctrackType=proctrack/pgid
41 CacheGroups=0
42 ReturnToService=2
43 TaskPlugin=task/affinity
44 #
45 # TIMERS
46 SlurmctldTimeout=300
47 SlurmdTimeout=300
48 InactiveLimit=0
49 MinJobAge=300
50 KillWait=30
51 Waittime=0
52 #
53 # SCHEDULING
54 SchedulerType=sched/backfill
55 SchedulerPort=7321
56 SelectType=select/linear
57 FastSchedule=0
58 #
59 # LOGGING
60 SlurmctldDebug=3
61 #SlurmctldLogFile=
62 SlurmdDebug=3
63 #SlurmdLogFile=
64 JobCompType=jobcomp/none
65 #JobCompLoc=
66 JobAcctGatherType=jobacct_gather/none
67 #
68 # COMPUTE NODES
69 NodeName=DEFAULT
70 PartitionName=DEFAULT MaxTime=INFINITE State=UP
71
72 NodeName=compute[0-255]
73 PartitionName=compute Nodes=compute[0-255] Default=YES Shared=YES
74 </pre>
75 </notextile>
76
77 h3. SLURM configuration essentials
78
79 Whenever you change this file, you will need to update the copy _on every compute node_ as well as the controller node, and then run @sudo scontrol reconfigure@.
80
81 *@ControlMachine@* should be a DNS name that resolves to the SLURM controller (dispatch/API server). This must resolve correctly on all SLURM worker nodes as well as the controller itself. In general SLURM is very sensitive about all of the nodes being able to communicate with the controller _and one another_, all using the same DNS names.
82
83 *@NodeName=compute[0-255]@* establishes that the hostnames of the worker nodes will be compute0, compute1, etc. through compute255.
84 * There are several ways to compress sequences of names, like @compute[0-9,80,100-110]@. See the "hostlist" discussion in the @slurm.conf(5)@ and @scontrol(1)@ man pages for more information.
85 * It is not necessary for all of the nodes listed here to be alive in order for SLURM to work, although you should make sure the DNS entries exist. It is easiest to define lots of hostnames up front, assigning them to real nodes and updating your DNS records as the nodes appear. This minimizes the frequency of @slurm.conf@ updates and use of @scontrol reconfigure@.
86
87 Each hostname in @slurm.conf@ must also resolve correctly on all SLURM worker nodes as well as the controller itself. Furthermore, the hostnames used in the configuration file must match the hostnames reported by @hostname@ or @hostname -s@ on the nodes themselves. This applies to the ControlMachine as well as the worker nodes.
88
89 For example:
90 * In @slurm.conf@ on control and worker nodes: @ControlMachine=uuid_prefix.your.domain@
91 * In @slurm.conf@ on control and worker nodes: @NodeName=compute[0-255]@
92 * In @/etc/resolv.conf@ on control and worker nodes: @search uuid_prefix.your.domain@
93 * On the control node: @hostname@ reports @uuid_prefix.your.domain@
94 * On worker node 123: @hostname@ reports @compute123.uuid_prefix.your.domain@
95
96 h3. Automatic hostname assignment
97
98 The API server will choose an unused hostname from the set given in @application.yml@, which defaults to @compute[0-255]@.
99
100 If it is not feasible to give your compute nodes hostnames like compute0, compute1, etc., you can accommodate other naming schemes with a bit of extra configuration.
101
102 If you want Arvados to assign names to your nodes with a different consecutive numeric series like @{worker1-0000, worker1-0001, worker1-0002}@, add an entry to @application.yml@; see @/var/www/arvados-api/current/config/application.default.yml@ for details. Example:
103 * In @application.yml@: <code>assign_node_hostname: worker1-%<slot_number>04d</code>
104 * In @slurm.conf@: <code>NodeName=worker1-[0000-0255]</code>
105
106 If your worker hostnames are already assigned by other means, and the full set of names is known in advance, have your worker node bootstrapping script (see "Installing a compute node":install-compute-node.html) send its current hostname, rather than expect Arvados to assign one.
107 * In @application.yml@: <code>assign_node_hostname: false</code>
108 * In @slurm.conf@: <code>NodeName=alice,bob,clay,darlene</code>
109
110 If your worker hostnames are already assigned by other means, but the full set of names is _not_ known in advance, you can use the @slurm.conf@ and @application.yml@ settings in the previous example, but you must also update @slurm.conf@ (both on the controller and on all worker nodes) and run @sudo scontrol reconfigure@ whenever a new node comes online.