1/etc/containerd/config.toml(5)File Formats Manual/etc/containerd/config.toml(5)
2
6 The config.toml file is a configuration file for the containerd daemon.
7 The file must be placed at /etc/containerd/config.toml or specified
8 with the --config option of containerd to be used by the daemon. If the
9 file does not exist at the appropriate location or is not provided via
10 the --config option containerd uses its default configuration settings,
11 which can be displayed with the containerd config(1) command.
12
15 The TOML file used to configure the containerd daemon settings has a
16 short list of global settings followed by a series of sections for spe‐
17 cific areas of daemon configuration. There is also a section for plug‐
18 ins that allows each containerd plugin to have an area for plugin-spe‐
19 cific configuration and settings.
20
23 root : The root directory for containerd metadata. (Default:
24 "/var/lib/containerd")
25 state : The state directory for containerd (Default: "/run/containerd")
28 oom_score : The out of memory (OOM) score applied to the containerd
31 daemon process (Default: 0)
32 [grpc] : Section for gRPC socket listener settings. Contains three
35 properties:
36 - address (Default: "/run/containerd/containerd.sock")
37 - uid (Default: 0)
38 - gid (Default: 0)
39 [debug] : Section to enable and configure a debug socket listener. Con‐
42 tains four properties:
43 - address (Default: "/run/containerd/debug.sock")
44 - uid (Default: 0)
45 - gid (Default: 0)
46 - level (Default: "info") sets the debug log level
47 [metrics] : Section to enable and configure a metrics listener. Con‐
50 tains two properties:
51 - address (Default: "") Metrics endpoint does not listen by default
52 - grpc_histogram (Default: false) Turn on or off gRPC histogram met‐
53 rics
54 [cgroup] : Section for Linux cgroup specific settings
57 - path (Default: "") Specify a custom cgroup path for created contain‐
58 ers
59 [plugins] : The plugins section contains configuration options exposed
62 from installed plugins. The following plugins are enabled by default
63 and their settings are shown below. Plugins that are not enabled by
64 default will provide their own configuration values documentation.
65 - [plugins.cgroup] has one option no_prometheus (Default: false)
66 - [plugins.diff] has one option default, a list by default set to
67 ["walking"]
68 - [plugins.linux] has several options for configuring the runtime,
69 shim, and related options:
70 shim specifies the shim binary (Default: "containerd-shim"),
71 runtime is the OCI compliant runtime binary (Default: "runc"),
72 runtime_root is the root directory used by the runtime (Default:
73 ""),
74 no_shim specifies whether to use a shim or not (Default: false),
75 shim_debug turns on debugging for the shim (Default: false)
76 - [plugins.scheduler] has several options that perform advanced tuning
77 for the scheduler:
78 pause_threshold is the maximum amount of time GC should be scheduled
79 (Default: 0.02),
80 deletion_threshold guarantees GC is scheduled after n number of
81 deletions (Default: 0 [not triggered]),
82 mutation_threshold guarantees GC is scheduled after n number of
83 database mutations (Default: 100),
84 schedule_delay defines the delay after trigger event before schedul‐
85 ing a GC (Default "0ms" [immediate]),
86 startup_delay defines the delay after startup before scheduling a GC
87 (Default "100ms")
88
91 The following is a complete config.toml default configuration example:
92 root = "/var/lib/containerd"
95 state = "/run/containerd"
96 oom_score = 0
97 [grpc]
99 address = "/run/containerd/containerd.sock"
100 uid = 0
101 gid = 0
102 [debug]
104 address = "/run/containerd/debug.sock"
105 uid = 0
106 gid = 0
107 level = "info"
108 [metrics]
110 address = ""
111 grpc_histogram = false
112 [cgroup]
114 path = ""
115 [plugins]
117 [plugins.cgroups]
118 no_prometheus = false
119 [plugins.diff]
120 default = ["walking"]
121 [plugins.linux]
122 shim = "containerd-shim"
123 runtime = "runc"
124 runtime_root = ""
125 no_shim = false
126 shim_debug = false
127 [plugins.scheduler]
128 pause_threshold = 0.02
129 deletion_threshold = 0
130 mutation_threshold = 100
131 schedule_delay = 0
132 startup_delay = 100000000
133
137 Please file any specific issues that you encounter at
138 ⟨https://github.com/containerd/containerd⟩.
140
143 Phil Estes ⟨estesp@gmail.com⟩
144
147 ctr(1), containerd-config(1), containerd(1)
148 08/08/2018 /etc/containerd/config.toml(5)