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)
33 Create environment file for container. File will have one envi‐
34 ronment variable per line.
35 Default is false.
37 RunTimeCreate
40 Pattern for OCI runtime create operation. See the section OCI
41 Pattern for details on pattern replacement.
42 Default: (disabled)
44 RunTimeDelete
47 Pattern for OCI runtime delete operation. See the section OCI
48 Pattern for details on pattern replacement.
49 Default: (disabled)
51 RunTimeKill
54 Pattern for OCI runtime kill operation. See the section OCI
55 Pattern for details on pattern replacement.
56 Default: (disabled)
58 RunTimeQuery
61 Pattern for OCI runtime query operation (also known as state).
62 See the section OCI Pattern for details on pattern replacement.
63 Default: (disabled)
65 RunTimeRun
68 Pattern for OCI runtime run operation. This is not provided in
69 the OCI runtime specification (<=v1.0) but is provided by multi‐
70 ple OCI runtimes to simplify execution of containers. If pro‐
71 vided, it will be used in the place of create and start opera‐
72 tions. It avoids the need to poll state of the container result‐
73 ing in less monitoring overhead. See the section OCI Pattern for
74 details on pattern replacement.
75 Default: (disabled)
77 RunTimeStart
80 Pattern for OCI runtime statrt operation. See the section OCI
81 Pattern for details on pattern replacement.
82 Default: (disabled)
84
87 OCI container support is disabled if oci.conf does not exist. If dis‐
88 abled, any user passing --container will be doing so in a purely advi‐
89 sor manner.
90
93 All of the OCI patterns will replace the following characters:
94 replacements:
96 • %% - replace as "%"
98 • %@ - replace as the command and arguments. Each argument will
100 be
101 enclosed with single quotes and escaped.
102 • %b - replace as OCI Bundle Path
104 • %e - replace as path to file containing environment if Cre‐
106 ateEnvFile=true.
107 • %j - replace as numeric job id
109 • %n - replace as nodename
111 • %r - replace as original path to rootfs
113 • %s - replace as numeric step id
115 • %t - replace as numeric step task id
117 • %u - replace as user name
119
122 Copyright (C) 2021 SchedMD LLC.
123 This file is part of Slurm, a resource management program. For de‐
126 tails, see <https://slurm.schedmd.com/>.
127 Slurm is free software; you can redistribute it and/or modify it under
129 the terms of the GNU General Public License as published by the Free
130 Software Foundation; either version 2 of the License, or (at your op‐
131 tion) any later version.
132 Slurm is distributed in the hope that it will be useful, but WITHOUT
134 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
135 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
136 for more details.
137
140 slurm.conf(5)
141July 2021 Slurm Configuration File oci.conf(5)