Slurm Workload Manager -

    This file is only required on the head node(s), where the slurmctld daemon
    executes.
    The file location can be modified at system build time using the
    DEFAULT_SLURM_CONF parameter or at execution time by setting the SLURM_CONF
    environment variable.
    The file will always be located in the same directory as the \fBslurm.conf\fP
    file.
    In order to support multiple configuration files for multiple burst buffer
    plugins, the configuration file may alternately be given a name containing
    the plugin name.
    For example, if "burst_buffer.conf" is not found, the burst_buffer/datawarp
    configuration could be read from a file named "burst_buffer_datawarp.conf".
    .LP
    Parameter names are case insensitive.
    Any text following a "#" in the configuration file is treated
    as a comment through the end of that line.
    Changes to the configuration file take effect upon restart of
    Slurm daemons, daemon receipt of the SIGHUP signal, or execution
    of the command "scontrol reconfigure".
    .LP
    The configuration parameters available include:

    .TP
    \fBAllowUsers\fR
    Comma separated list of user names and/or IDs permitted to use burst buffers.
    The options \fBAllowUsers\fR and \fBDenyUsers\fR can not both be specified.
    By default all users are permitted to use burst buffers.

    .\" Possible future enhancement for generic plugin
    .\" .TP
    .\" \fBAltPool\fR
    .\" The AltPool value consists of a comma separated list of alternate pools of
    .\" resources, each of which includes a name separated by a colon and a numeric
    .\" value.
    .\" The numeric value can include a suffix of "k", "m", "g", "t" and "p" which
    .\" multiplies the numeric value by 1,024, 1,048,576, 1,073,741,824 etc.
    .\" The numeric value is a 64-bit value.
    .\" for example, "AltPool=test:20g,small:4g

    .\".TP
    .\"\fBCreateBuffer\fR
    .\"Fully qualified path name of a program which will create both persistent
    .\"and per\-job burst buffers.
    .\"This option is not used by the burst_buffer/datawarp plugin.

    .TP
    \fBDefaultPool\fR
    Name of the pool used by default for resource allocations.
    The default value is the first pool reported by the burst buffer infrastructure.
    This option is only used by the burst_buffer/datawarp plugin.

    .TP
    Multiple options may be comma separated.
    Supported options include:
    .RS
    .TP
    \fBDisablePersistent\fR
    Prevents regular users from being able to create and destroy persistent burst buffers.
    This is the default behaviour, only privileged users (Slurm operators and
    administrators) can create or destroy persistent burst buffers.
    .TP
    \fBEmulateCray\fR
    Emulating a Cray DataWarp system using the dw_wlm_cli script in the burst_buffer/datawarp plugin.
    .TP
    \fBEnablePersistent\fR
    Enables regular users to create and destroy persistent burst buffers.
    By default, only privileged users (Slurm operators and administrators) can
    create or destroy persistent burst buffers.
    .TP
    \fBPrivateData\fR
    If set, then only Slurm operators and the burst buffer owner can see burst
    buffer data.
    .TP
    \fBSetExecHost\fR
    If using Cray DataWarp version CLE.6.0.UP07 or later, this flag may be set to
    notify DataWarp of the login node for an interactive jobs. This changes
    behavior such that the login node will be given access to the DataWarp burst
    buffers.
    .TP
    \fBTeardownFailure\fR
    If set, then teardown a burst buffer after file staging error. Otherwise
    preserve the burst buffer for analysis and manual teardown.
    .RE

    .TP
    \fBGetSysState\fR
    Fully qualified path name of a program which will return the current burst
    buffer state.
    .\"See the src/plugins/burst_buffer/generic/bb_get_state.example in the
    .\"Slurm distribution for an example.
    For the DataWarp plugin, this should be the path of the \fIdw_wlm_cli\fR command
    and its default value is /opt/cray/dw_wlm/default/bin/dw_wlm_cli.

    .TP
    \fBGetSysStatus\fR
    Fully qualified path name of a program which will return the current burst
    buffer status.
    For the DataWarp plugin, this should be the path of the \fIdwstat\fR command
    and its default value is /opt/cray/dws/default/bin/dwstat.

    .\".TP
    .\"\fBGranularity\fR
    .\"Granularity of job space allocations in units of bytes.
    .\"The numeric value may have a suffix of "m" (megabytes), "g" (gigabytes),
    .TP
    \fBPrivateData\fR
    If set to "true" then users will only be able to view burst buffers they can
    use.
    Slurm administrators will still be able to view all burst buffers.
    By default, users can view all burst buffers.

    .TP
    \fBStageInTimeout\fR
    If the stage in of files for a job takes more than this number of seconds,
    the burst buffer will be released and the job will be placed in a held state.
    A Slurm administrator will be required to release the job.
    By default there is a one day timeout for the stage in process.

    .TP
    \fBStageOutTimeout\fR
    If the stage out of files for a job takes more than this number of seconds,
    the burst buffer will be released and the job will be purged.
    By default there is a one day timeout for the stage out process.

    .\".TP
    .\"\fBStartStageIn\fR
    .\"Fully qualified path name of a program which will stage files in for a job.
    .\"See the src/plugins/burst_buffer/generic/bb_start_stage_in.example in the
    .\"Slurm distribution for an example.
    .\"This option is not used by the burst_buffer/datawarp plugin.

    .\".TP
    .\"\fBStartStageOut\fR
    .\"Fully qualified path name of a program which will stage files out for a job.
    .\"See the src/plugins/burst_buffer/generic/bb_start_stage_out.example in the
    .\"Slurm distribution for an example.
    .\"This option is not used by the burst_buffer/datawarp plugin.

    .\".TP
    .\"\fBStopStageIn\fR
    .\"Fully qualified path name of a program which will stop staging files in for a job.
    .\"See the src/plugins/burst_buffer/generic/bb_stop_stage_out.example in the
    .\"Slurm distribution for an example.
    .\"This option is not used by the burst_buffer/datawarp plugin.

    .\".TP
    .\"\fBStopStageOut\fR
    .\"Fully qualified path name of a program which will stop staging files in for a job.
    .\"See the src/plugins/burst_buffer/generic/bb_stop_stage_out.example in the
    .\"Slurm distribution for an example.
    .\"This option is not used by the burst_buffer/datawarp plugin.

    .TP
    \fBValidateTimeout\fR
    If the validation of a job submission request takes more than this number of
    seconds, the submission will be rejected.
    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)