1burst_buffer.conf(5) File Formats Manual burst_buffer.conf(5)
2
3
4
6 burst_buffer.conf - Slurm configuration file for burst buffer manage‐
7 ment.
8
9
11 burst_buffer.conf is an ASCII file which describes the configuration of
12 burst buffer resource management. This file is only required on the
13 head node(s), where the slurmctld daemon executes. The file will al‐
14 ways be located in the same directory as the slurm.conf.
15
16 Parameter names are case insensitive. Any text following a "#" in the
17 configuration file is treated as a comment through the end of that
18 line. Changes to the configuration file take effect upon restart of
19 Slurm daemons, daemon receipt of the SIGHUP signal, or execution of the
20 command "scontrol reconfigure".
21
22 The configuration parameters available include:
23
24
25 AllowUsers
26 Comma separated list of user names and/or IDs permitted to use
27 burst buffers. The options AllowUsers and DenyUsers can not
28 both be specified. By default all users are permitted to use
29 burst buffers.
30
31 DefaultPool
32 Name of the pool used by default for resource allocations. The
33 default value is the first pool reported by the burst buffer in‐
34 frastructure. This option is only used by the burst_buf‐
35 fer/datawarp plugin.
36
37 DenyUsers
38 Colon delimited list of user names and/or IDs prevented from us‐
39 ing burst buffers. The options AllowUsers and DenyUsers can not
40 both be specified. By default all users are permitted to use
41 burst buffers.
42
43 Directive
44 The string that must be used by a job to request a burst buffer.
45 This string must be immediately preceeded by a single '#' char‐
46 acter. This is currently only used by the lua plugin. For the
47 lua plugin, the default value is "BB_LUA". See burst_buf‐
48 fer.html for more details.
49
50 Flags String used to control various functions. Multiple options may
51 be comma separated. Supported options include:
52
53 DisablePersistent
54 Prevents regular users from being able to create and de‐
55 stroy persistent burst buffers. This is the default be‐
56 haviour, only privileged users (Slurm operators and ad‐
57 ministrators) can create or destroy persistent burst buf‐
58 fers.
59
60 EmulateCray
61 Emulating a Cray DataWarp system using the dw_wlm_cli
62 script in the burst_buffer/datawarp plugin. This is only
63 used by the datawarp plugin.
64
65 EnablePersistent
66 Enables regular users to create and destroy persistent
67 burst buffers. By default, only privileged users (Slurm
68 operators and administrators) can create or destroy per‐
69 sistent burst buffers. This is only used by the datawarp
70 plugin.
71
72 PrivateData
73 If set, then only Slurm operators and the burst buffer
74 owner can see burst buffer data.
75
76 TeardownFailure
77 If set, then teardown a burst buffer after file staging
78 error. Otherwise preserve the burst buffer for analysis
79 and manual teardown.
80
81 GetSysState
82 Fully qualified path name of a program which will return the
83 current burst buffer state. For the DataWarp plugin, this
84 should be the path of the dw_wlm_cli command and its default
85 value is /opt/cray/dw_wlm/default/bin/dw_wlm_cli. This is not
86 used by the lua plugin.
87
88 GetSysStatus
89 Fully qualified path name of a program which will return the
90 current burst buffer status. For the DataWarp plugin, this
91 should be the path of the dwstat command and its default value
92 is /opt/cray/dws/default/bin/dwstat. This is not used by the
93 lua plugin.
94
95 OtherTimeout
96 If a burst buffer operation (other than job validation, stage
97 in, or stage out) runs for longer than this number of seconds,
98 the job will be placed in a held state. A Slurm administrator
99 will be required to release the job. By default there is a 300
100 second (5 minute) timeout for these operations. Also see
101 StageInTimeout, StageOutTimeout, and ValidateTimeout options.
102 For the lua plugin, the maximum timeout value is 2073600 seconds
103 (24 days).
104
105 PrivateData
106 If set to "true" then users will only be able to view burst buf‐
107 fers they can use. Slurm administrators will still be able to
108 view all burst buffers. By default, users can view all burst
109 buffers.
110
111 StageInTimeout
112 If the stage in of files for a job takes more than this number
113 of seconds, the burst buffer will be released and the job will
114 be placed in a held state. A Slurm administrator will be re‐
115 quired to release the job. By default there is a one day time‐
116 out for the stage in process. For the lua plugin, the maximum
117 timeout value is 2073600 seconds (24 days).
118
119 StageOutTimeout
120 If the stage out of files for a job takes more than this number
121 of seconds, the burst buffer will be released and the job will
122 be purged. By default there is a one day timeout for the stage
123 out process. For the lua plugin, the maximum timeout value is
124 2073600 seconds (24 days).
125
126 ValidateTimeout
127 If the validation of a job submission request takes more than
128 this number of seconds, the submission will be rejected. The
129 value of ValidateTimeout must be less than the value of Message‐
130 Timeout configured in the slurm.conf file or job submission re‐
131 quests may fail with a response timeout error. By default there
132 is a 5 second timeout for the validation operations. In the lua
133 plugin, because the validation operation cannot be killed, this
134 option is not used.
135
137 Copyright (C) 2014-2022 SchedMD LLC.
138
139 This file is part of Slurm, a resource management program. For de‐
140 tails, see <https://slurm.schedmd.com/>.
141
142 Slurm is free software; you can redistribute it and/or modify it under
143 the terms of the GNU General Public License as published by the Free
144 Software Foundation; either version 2 of the License, or (at your op‐
145 tion) any later version.
146
147 Slurm is distributed in the hope that it will be useful, but WITHOUT
148 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
149 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
150 for more details.
151
152
154 slurm.conf(5)
155
156
157
158Slurm configuration file January 2022 burst_buffer.conf(5)