1/etc/containerd/config.toml(5)File Formats Manual/etc/containerd/config.toml(5)
2
3
4
6 containerd-config.toml - configuration file for containerd
7
8
10 The config.toml file is a configuration file for the containerd daemon.
11 The file must be placed at /etc/containerd/config.toml or specified
12 with the --config option of containerd to be used by the daemon. If the
13 file does not exist at the appropriate location or is not provided via
14 the --config option containerd uses its default configuration settings,
15 which can be displayed with the containerd config(1) command.
16
17
19 The TOML file used to configure the containerd daemon settings has a
20 short list of global settings followed by a series of sections for spe‐
21 cific areas of daemon configuration. There is also a section for plug‐
22 ins that allows each containerd plugin to have an area for plugin-spe‐
23 cific configuration and settings.
24
25
27 root The root directory for containerd metadata. (Default:
28 "/var/lib/containerd")
29
30
31 state The state directory for containerd (Default: "/run/containerd")
32
33
34 oom_score
35 The out of memory (OOM) score applied to the containerd daemon
36 process (Default: 0)
37
38
39 imports
40 Imports is a list of additional configuration files to include.
41 This allows to split the main configuration file and keep some
42 sections separately (for example vendors may keep a custom run‐
43 time configuration in a separate file without modifying the main
44 config.toml). Imported files will overwrite simple fields like
45 int or string (if not empty) and will append array and map
46 fields.
47
48
49 [grpc] Section for gRPC socket listener settings. Contains three prop‐
50 erties:
51
52 · address (Default: "/run/containerd/containerd.sock")
53
54 · uid (Default: 0)
55
56 · gid (Default: 0)
57
58
59
60
61 [debug]
62 Section to enable and configure a debug socket listener. Con‐
63 tains four properties:
64
65 · address (Default: "/run/containerd/debug.sock")
66
67 · uid (Default: 0)
68
69 · gid (Default: 0)
70
71 · level (Default: "info") sets the debug log level
72
73
74
75
76 [metrics]
77 Section to enable and configure a metrics listener. Contains two
78 properties:
79
80 · address (Default: "") Metrics endpoint does not listen by
81 default
82
83 · grpc_histogram (Default: false) Turn on or off gRPC histogram
84 metrics
85
86
87
88
89 [cgroup]
90 Section for Linux cgroup specific settings
91
92 · path (Default: "") Specify a custom cgroup path for created
93 containers
94
95
96
97
98 [plugins]
99 The plugins section contains configuration options exposed from
100 installed plugins. The following plugins are enabled by default
101 and their settings are shown below. Plugins that are not
102 enabled by default will provide their own configuration values
103 documentation.
104
105 · [plugins.cgroup] has one option no_prometheus (Default: false)
106
107 · [plugins.diff] has one option default, a list by default set
108 to ["walking"]
109
110 · [plugins.linux] has several options for configuring the run‐
111 time, shim, and related options: shim specifies the shim
112 binary (Default: "containerd-shim"), runtime is the OCI com‐
113 pliant runtime binary (Default: "runc"), runtime_root is the
114 root directory used by the runtime (Default: ""), no_shim
115 specifies whether to use a shim or not (Default: false),
116 shim_debug turns on debugging for the shim (Default: false)
117
118 · [plugins.scheduler] has several options that perform advanced
119 tuning for the scheduler: pause_threshold is the maximum
120 amount of time GC should be scheduled (Default: 0.02), dele‐
121 tion_threshold guarantees GC is scheduled after n number of
122 deletions (Default: 0 [not triggered]), mutation_threshold
123 guarantees GC is scheduled after n number of database muta‐
124 tions (Default: 100), schedule_delay defines the delay after
125 trigger event before scheduling a GC (Default "0ms" [immedi‐
126 ate]), startup_delay defines the delay after startup before
127 scheduling a GC (Default "100ms")
128
129
130
131
133 The following is a complete config.toml default configuration example:
134
135
136 root = "/var/lib/containerd"
137 state = "/run/containerd"
138 oom_score = 0
139 imports = ["/etc/containerd/runtime_*.toml", "./debug.toml"]
140
141 [grpc]
142 address = "/run/containerd/containerd.sock"
143 uid = 0
144 gid = 0
145
146 [debug]
147 address = "/run/containerd/debug.sock"
148 uid = 0
149 gid = 0
150 level = "info"
151
152 [metrics]
153 address = ""
154 grpc_histogram = false
155
156 [cgroup]
157 path = ""
158
159 [plugins]
160 [plugins.cgroups]
161 no_prometheus = false
162 [plugins.diff]
163 default = ["walking"]
164 [plugins.linux]
165 shim = "containerd-shim"
166 runtime = "runc"
167 runtime_root = ""
168 no_shim = false
169 shim_debug = false
170 [plugins.scheduler]
171 pause_threshold = 0.02
172 deletion_threshold = 0
173 mutation_threshold = 100
174 schedule_delay = 0
175 startup_delay = 100000000
176
177
178
180 Please file any specific issues that you encounter at
181 https://github.com/containerd/containerd.
182
183
185 Phil Estes estesp@gmail.com ⟨mailto:estesp@gmail.com⟩
186
187
189 ctr(1), containerd-config(1), containerd(1)
190
191
192
193 08/08/2018 /etc/containerd/config.toml(5)