1oci.conf(5) Slurm Configuration File oci.conf(5)
2
6 oci.conf - Slurm configuration file for containers.
7
10 Slurm supports calling OCI compliant runtimes. oci.conf is an ASCII
11 file which defines parameters used by OCI runtime interface.
12 Parameter names are case insensitive. Any text following a "#" in the
15 configuration file is treated as a comment through the end of that
16 line. Changes to the configuration file take effect upon restart of
17 Slurm daemons.
18 The following oci.conf parameters are defined to control the behavior
21 of the --container argument of salloc, srun, and sbatch
22 ContainerPath
25 Override path pattern for placement of the generated OCI Con‐
26 tainer bundle directory. See the section OCI Pattern for details
27 on pattern replacement.
28 Default is unique directory generated in SlurmdSpoolDir.
30 CreateEnvFile=(true|false)
32 Create environment file for container. File will have one envi‐
33 ronment variable per line.
34 Default is false.
36 RunTimeCreate
38 Pattern for OCI runtime create operation. See the section OCI
39 Pattern for details on pattern replacement.
40 Default: (disabled)
42 RunTimeDelete
44 Pattern for OCI runtime delete operation. See the section OCI
45 Pattern for details on pattern replacement.
46 Default: (disabled)
48 RunTimeKill
50 Pattern for OCI runtime kill operation. See the section OCI
51 Pattern for details on pattern replacement.
52 Default: (disabled)
54 RunTimeQuery
56 Pattern for OCI runtime query operation (also known as state).
57 See the section OCI Pattern for details on pattern replacement.
58 Default: (disabled)
60 RunTimeRun
62 Pattern for OCI runtime run operation. This is not provided in
63 the OCI runtime specification (<=v1.0) but is provided by multi‐
64 ple OCI runtimes to simplify execution of containers. If pro‐
65 vided, it will be used in the place of create and start opera‐
66 tions. It avoids the need to poll state of the container result‐
67 ing in less monitoring overhead. See the section OCI Pattern for
68 details on pattern replacement.
69 Default: (disabled)
71 RunTimeStart
73 Pattern for OCI runtime statrt operation. See the section OCI
74 Pattern for details on pattern replacement.
75 Default: (disabled)
77
79 OCI container support is disabled if oci.conf does not exist. If dis‐
80 abled, any user passing --container will be doing so in a purely advi‐
81 sor manner.
82
85 All of the OCI patterns will replace the following characters:
86 Replacements:
88 %% Replace as "%".
91 %@ Replace as the command and arguments. Each argument will be en‐
93 closed with single quotes and escaped.
94 %b Replace as OCI Bundle Path.
96 %e Replace as path to file containing environment if CreateEn‐
98 vFile=true.
99 %j Replace as numeric job id.
101 %n Replace as nodename.
103 %r Replace as original path to rootfs.
105 %s Replace as numeric step id.
107 %t Replace as numeric step task id.
109 %u Replace as user name.
111
113 Copyright (C) 2021 SchedMD LLC.
114 This file is part of Slurm, a resource management program. For de‐
117 tails, see <https://slurm.schedmd.com/>.
118 Slurm is free software; you can redistribute it and/or modify it under
120 the terms of the GNU General Public License as published by the Free
121 Software Foundation; either version 2 of the License, or (at your op‐
122 tion) any later version.
123 Slurm is distributed in the hope that it will be useful, but WITHOUT
125 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
126 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
127 for more details.
128
131 slurm.conf(5)
132July 2021 Slurm Configuration File oci.conf(5)