1burst_buffer.conf(5)          File Formats Manual         burst_buffer.conf(5)
2
3
4

NAME

6       burst_buffer.conf  -  Slurm configuration file for burst buffer manage‐
7       ment.
8
9

DESCRIPTION

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
15       parameter 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.  In order to support multiple configuration files  for
18       multiple  burst  buffer plugins, the configuration file may alternately
19       be  given  a  name  containing  the  plugin  name.   For  example,   if
20       "burst_buffer.conf"  is not found, the burst_buffer/datawarp configura‐
21       tion could be read from a file named "burst_buffer_datawarp.conf".
22
23       Parameter names are case insensitive.  Any text following a "#" in  the
24       configuration  file  is  treated  as  a comment through the end of that
25       line.  Changes to the configuration file take effect  upon  restart  of
26       Slurm daemons, daemon receipt of the SIGHUP signal, or execution of the
27       command "scontrol reconfigure".
28
29       The configuration parameters available include:
30
31
32       AllowUsers
33              Comma separated list of user names and/or IDs permitted  to  use
34              burst  buffers.   The  options  AllowUsers and DenyUsers can not
35              both be specified.  By default all users are  permitted  to  use
36              burst buffers.
37
38
39
40
41       DefaultPool
42              Name  of the pool used by default for resource allocations.  The
43              default value is the first pool reported by the burst buffer in‐
44              frastructure.   This  option  is  only  used  by  the burst_buf‐
45              fer/datawarp plugin.
46
47
48       DenyUsers
49              Colon delimited list of user names  and/or  IDs  prevented  from
50              using  burst  buffers.  The options AllowUsers and DenyUsers can
51              not both be specified.  By default all users  are  permitted  to
52              use burst buffers.
53
54
55
56       Flags  String  used to control various functions.  Multiple options may
57              be comma separated.  Supported options include:
58
59              DisablePersistent
60                     Prevents regular users from  being  able  to  create  and
61                     destroy  persistent  burst  buffers.  This is the default
62                     behaviour, only privileged  users  (Slurm  operators  and
63                     administrators)  can  create  or destroy persistent burst
64                     buffers.
65
66              EmulateCray
67                     Emulating a Cray DataWarp  system  using  the  dw_wlm_cli
68                     script in the burst_buffer/datawarp plugin.
69
70              EnablePersistent
71                     Enables  regular  users  to create and destroy persistent
72                     burst buffers.  By default, only privileged users  (Slurm
73                     operators  and administrators) can create or destroy per‐
74                     sistent burst buffers.
75
76              PrivateData
77                     If set, then only Slurm operators and  the  burst  buffer
78                     owner can see burst buffer data.
79
80              SetExecHost
81                     If  using  Cray  DataWarp  version CLE.6.0.UP07 or later,
82                     this flag may be set to notify DataWarp of the login node
83                     for  an interactive jobs. This changes behavior such that
84                     the login node will be given access to the DataWarp burst
85                     buffers.
86
87              TeardownFailure
88                     If  set,  then teardown a burst buffer after file staging
89                     error. Otherwise preserve the burst buffer  for  analysis
90                     and manual teardown.
91
92
93       GetSysState
94              Fully  qualified  path  name  of a program which will return the
95              current burst buffer  state.   For  the  DataWarp  plugin,  this
96              should  be  the  path  of the dw_wlm_cli command and its default
97              value is /opt/cray/dw_wlm/default/bin/dw_wlm_cli.
98
99
100       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.
105
106
107
108       OtherTimeout
109              If  a  burst  buffer operation (other than job validation, stage
110              in, or stage out) runs for longer than this number  of  seconds,
111              the  job  will be placed in a held state.  A Slurm administrator
112              will be required to release the job.  By default there is a  300
113              second  (5  minute)  timeout  for  these  operations.   Also see
114              StageInTimeout, StageOutTimeout, and ValidateTimeout options.
115
116
117       PrivateData
118              If set to "true" then users will only be able to view burst buf‐
119              fers  they  can use.  Slurm administrators will still be able to
120              view all burst buffers.  By default, users can  view  all  burst
121              buffers.
122
123
124       StageInTimeout
125              If  the  stage in of files for a job takes more than this number
126              of seconds, the burst buffer will be released and the  job  will
127              be  placed  in  a  held  state.   A  Slurm administrator will be
128              required to release the job.  By default  there  is  a  one  day
129              timeout for the stage in process.
130
131
132       StageOutTimeout
133              If  the stage out of files for a job takes more than this number
134              of seconds, the burst buffer will be released and the  job  will
135              be  purged.  By default there is a one day timeout for the stage
136              out process.
137
138
139
140
141
142
143       ValidateTimeout
144              If the validation of a job submission request  takes  more  than
145              this  number  of  seconds, the submission will be rejected.  The
146              value of ValidateTimeout must be less than the value of Message‐
147              Timeout  configured  in  the  slurm.conf  file or job submission
148              requests may fail with a response  timeout  error.   By  default
149              there is a 5 second timeout for the validation operations.
150
151

COPYING

153       Copyright (C) 2014-2018 SchedMD LLC.
154
155       This  file  is  part  of  Slurm,  a  resource  management program.  For
156       details, see <https://slurm.schedmd.com/>.
157
158       Slurm is free software; you can redistribute it and/or modify it  under
159       the  terms  of  the GNU General Public License as published by the Free
160       Software Foundation; either version 2  of  the  License,  or  (at  your
161       option) any later version.
162
163       Slurm  is  distributed  in the hope that it will be useful, but WITHOUT
164       ANY WARRANTY; without even the implied warranty of  MERCHANTABILITY  or
165       FITNESS  FOR  A PARTICULAR PURPOSE.  See the GNU General Public License
166       for more details.
167
168

SEE ALSO

170       slurm.conf(5)
171
172
173
174Slurm configuration file           June 2019              burst_buffer.conf(5)
Impressum