1topology.conf(5)           Slurm Configuration File           topology.conf(5)
2
3
4

NAME

6       topology.conf  -  Slurm  configuration  file  for  defining the network
7       topology
8
9

PREREQUISITES

11       Topology.conf can only represent a hierarchical network. All  nodes  in
12       the  network must be connected to at least one switch. The network must
13       be fully connected to use a RoutePlugin. Jobs can only span nodes  con‐
14       nected  by  the  same  switch  fabric, even if there are available idle
15       nodes.
16
17

DESCRIPTION

19       topology.conf is an ASCII file which describes  the  cluster's  network
20       topology  for optimized job resource allocation.  The file location can
21       be modified at system build time using the DEFAULT_SLURM_CONF parameter
22       or  at  execution  time by setting the SLURM_CONF environment variable.
23       The file will always be located in the same directory as the slurm.conf
24       file.
25
26       Parameter  names are case insensitive.  Any text following a "#" in the
27       configuration file is treated as a comment  through  the  end  of  that
28       line.   Changes  to  the configuration file take effect upon restart of
29       Slurm daemons, daemon receipt of the SIGHUP signal, or execution of the
30       command "scontrol reconfigure" unless otherwise noted.
31
32       The  network topology configuration one line defining a switch name and
33       its children, either node names or switch names.  Slurm's hostlist  ex‐
34       pression  parser is used, so the node and switch names need not be con‐
35       secutive (e.g. "Nodes=tux[0-3,12,18-20]"  and  "Switches=s[0-2,4-8,12]"
36       will parse fine).  An optional link speed may also be specified.
37
38       The  topology.conf  file  for an Infiniband switch can be automatically
39       generated    using    the    slurmibtopology    tool    found     here:
40       <https://ftp.fysik.dtu.dk/Slurm/slurmibtopology.sh>.
41
42       The overall configuration parameters available include:
43
44
45       SwitchName
46              The  name  of a switch. This name is internal to Slurm and arbi‐
47              trary.  Each switch should have a unique name.  This field  must
48              be specified.
49
50       Switches
51              Child  switches  of the named switch.  Either this option or the
52              Nodes option must be specified.
53
54       Nodes  Child Nodes of the named leaf switch.  Either this option or the
55              Switches option must be specified.
56
57       LinkSpeed
58              An  optional value specifying the performance of this communica‐
59              tion link.  The units used are arbitrary and this information is
60              currently  not  used.   It may be used in the future to optimize
61              resource allocations.
62
63

EXAMPLE

65       ##################################################################
66       # Slurm's network topology configuration file for use with the
67       # topology/tree plugin
68       ##################################################################
69       SwitchName=s0 Nodes=dev[0-5]
70       SwitchName=s1 Nodes=dev[6-11]
71       SwitchName=s2 Nodes=dev[12-17]
72       SwitchName=s3 Switches=s[0-2]
73
74

COPYING

76       Copyright (C) 2009 Lawrence Livermore National Security.   Produced  at
77       Lawrence Livermore National Laboratory (cf, DISCLAIMER).
78       Copyright (C) 2010-2021 SchedMD LLC.
79
80       This  file  is  part  of Slurm, a resource management program.  For de‐
81       tails, see <https://slurm.schedmd.com/>.
82
83       Slurm is free software; you can redistribute it and/or modify it  under
84       the  terms  of  the GNU General Public License as published by the Free
85       Software Foundation; either version 2 of the License, or (at  your  op‐
86       tion) any later version.
87
88       Slurm  is  distributed  in the hope that it will be useful, but WITHOUT
89       ANY WARRANTY; without even the implied warranty of  MERCHANTABILITY  or
90       FITNESS  FOR  A PARTICULAR PURPOSE.  See the GNU General Public License
91       for more details.
92
93

SEE ALSO

95       slurm.conf(5)
96
97
98
99April 2015                 Slurm Configuration File           topology.conf(5)
Impressum