topology.conf(5)

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

DESCRIPTION

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

EXAMPLE

58       ##################################################################
59       # Slurm's network topology configuration file for use with the
60       # topology/tree plugin
61       ##################################################################
62       SwitchName=s0 Nodes=dev[0-5]
63       SwitchName=s1 Nodes=dev[6-11]
64       SwitchName=s2 Nodes=dev[12-17]
65       SwitchName=s3 Switches=s[0-2]
66
67

COPYING

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

NAME

DESCRIPTION

EXAMPLE

COPYING

SEE ALSO