1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
.TH "topology.yaml" "5" "Slurm Configuration File" "Slurm 25.05" "Slurm Configuration File"
.SH "NAME"
topology.yaml \- Slurm configuration file for the topology plugins
.SH "DESCRIPTION"
.LP
\fBtopology.yaml\fR is a YAML\-formatted configuration file that defines
multiple network topologies for optimizing job resource allocation in Slurm.
The file must be located in the same directory as \fBslurm.conf\fR. Any text
following a "#" in this file is treated as a comment through the end of that
line.
Additional details are available in \fBtopology.conf\fR(5) and in the
Topology Guide: <https://slurm.schedmd.com/topology.html>
\fBNOTE\fR: Slurm will first check for topology.yaml.
If this file exists, topology.conf will be ignored.
.LP
.SH "PARAMETERS"
.LP
Each topology contains the following attributes:
.LP
.TP
\fBtopology\fR
Unique name of the topology, will be used to identify it on partition
configurations. Must be the first attribute.
.IP
.TP
\fBcluster_default\fR
The first topology defined with \fBcluster_default: true\fR will be used for
partitions without an explicitly specified topology and cluster-wide operations
not tied to a partition (e.g., slurmctld-to-slurmd communication). Defaults to
\fBfalse\fR.
.IP
.LP
Each topology must also define exactly one of the following topology types:
.RS
.TP
\fBblock\fR
This topology will use the \fBtopology/block\fR plugin. Must contain additional
fields, see below.
.IP
.TP
\fBflat\fR
If set to \fBtrue\fR, this topology will use the \fBtopology/flat\fR plugin,
which is the default if no TopologyPlugin or topology.yaml is specified.
.IP
.TP
\fBtree\fR
This topology will use the \fBtopology/tree\fR plugin. Must contain additional
fields, see below.
.IP
.RE
.SS "Block definitions"
.LP
Each block topology contains the following attributes:
.LP
.TP
\fBblock_sizes\fR
List of the planning base block size, alongside any
higher-level block sizes that would be enforced.
Successive \fBBlockSizes\fR must be a power of two larger than the prior values.
.IP
.TP
\fBblocks\fR
List of blocks available in this topology. Each block contains the following
attributes:
.RS
.TP
\fBblock\fR
The name of a block. This name is internal to Slurm and arbitrary.
Each block should have a unique name.
This field must be specified.
.IP
.TP
\fBnodes\fR
Child nodes of the named block.
.IP
.RE
.IP
.SS "Tree definitions"
.LP
Each tree topology contains the following attribute:
.LP
.TP
\fBswitches\fR
List of switches available in this topology. Each switch contains the following
attributes:
.RS
.TP
\fBswitch\fR
The name of a switch. This name is internal to Slurm and arbitrary.
Each switch should have a unique name.
This field must be specified and cannot be longer than 64 characters.
.IP
.TP
\fBchildren\fR
Child switches of the named switch.
.IP
.TP
\fBnodes\fR
Child nodes of the named leaf switch.
.IP
.RE
.IP
.SH "EXAMPLE"
.nf
---
- topology: topo1
cluster_default: true
tree:
switches:
- switch: sw_root
children: s[1-2]
- switch: s1
nodes: node[01-02]
- switch: s2
nodes: node[03-04]
- topology: topo2
cluster_default: false
block:
block_sizes:
- 4
- 16
blocks:
- block: b1
nodes: node[01-04]
- block: b2
nodes: node[05-08]
- block: b3
nodes: node[09-12]
- block: b4
nodes: node[13-16]
- topology: topo3
cluster_default: false
flat: true
.fi
.SH "COPYING"
Copyright (C) 2025 SchedMD LLC.
.LP
This file is part of Slurm, a resource management program.
For details, see <https://slurm.schedmd.com/>.
.LP
Slurm is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 2 of the License, or (at your option)
any later version.
.LP
Slurm is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
details.
.SH "SEE ALSO"
.LP
\fBslurm.conf\fR(5), \fBtopology.conf\fR(5)
|
