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