containerd-config.toml(5)

1/etc/containerd/config.toml(5)File Formats Manual/etc/containerd/config.toml(5)
2
3
4

NAME

6       containerd-config.toml - configuration file for containerd
7
8

SYNOPSIS

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

DESCRIPTION

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

FORMAT

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       [grpc] Section for gRPC socket listener settings. Contains three  prop‐
40              erties:
41
42              · address (Default: "/run/containerd/containerd.sock")
43
44              · uid (Default: 0)
45
46              · gid (Default: 0)
47
48
49
50
51       [debug]
52              Section  to  enable  and configure a debug socket listener. Con‐
53              tains four properties:
54
55              · address (Default: "/run/containerd/debug.sock")
56
57              · uid (Default: 0)
58
59              · gid (Default: 0)
60
61              · level (Default: "info") sets the debug log level
62
63
64
65
66       [metrics]
67              Section to enable and configure a metrics listener. Contains two
68              properties:
69
70              · address  (Default:  "")  Metrics  endpoint  does not listen by
71                default
72
73              · grpc_histogram (Default: false) Turn on or off gRPC  histogram
74                metrics
75
76
77
78
79       [cgroup]
80              Section for Linux cgroup specific settings
81
82              · path  (Default:  "")  Specify a custom cgroup path for created
83                containers
84
85
86
87
88       [plugins]
89              The plugins section contains configuration options exposed  from
90              installed plugins.  The following plugins are enabled by default
91              and their settings  are  shown  below.   Plugins  that  are  not
92              enabled  by  default will provide their own configuration values
93              documentation.
94
95              · [plugins.cgroup] has one option no_prometheus (Default: false)
96
97              · [plugins.diff] has one option default, a list by  default  set
98                to ["walking"]
99
100              · [plugins.linux]  has  several options for configuring the run‐
101                time, shim, and  related  options:  shim  specifies  the  shim
102                binary  (Default:  "containerd-shim"), runtime is the OCI com‐
103                pliant runtime binary (Default: "runc"), runtime_root  is  the
104                root  directory  used  by  the  runtime (Default: ""), no_shim
105                specifies whether to use  a  shim  or  not  (Default:  false),
106                shim_debug turns on debugging for the shim (Default: false)
107
108              · [plugins.scheduler]  has several options that perform advanced
109                tuning for  the  scheduler:  pause_threshold  is  the  maximum
110                amount  of  time GC should be scheduled (Default: 0.02), dele‐
111                tion_threshold guarantees GC is scheduled after  n  number  of
112                deletions  (Default:  0  [not  triggered]), mutation_threshold
113                guarantees GC is scheduled after n number  of  database  muta‐
114                tions  (Default:  100), schedule_delay defines the delay after
115                trigger event before scheduling a GC (Default  "0ms"  [immedi‐
116                ate]),  startup_delay  defines  the delay after startup before
117                scheduling a GC (Default "100ms")
118
119
120
121

EXAMPLE

123       The following is a complete config.toml default configuration example:
124
125
126              root = "/var/lib/containerd"
127              state = "/run/containerd"
128              oom_score = 0
129
130              [grpc]
131                address = "/run/containerd/containerd.sock"
132                uid = 0
133                gid = 0
134
135              [debug]
136                address = "/run/containerd/debug.sock"
137                uid = 0
138                gid = 0
139                level = "info"
140
141              [metrics]
142                address = ""
143                grpc_histogram = false
144
145              [cgroup]
146                path = ""
147
148              [plugins]
149                [plugins.cgroups]
150                  no_prometheus = false
151                [plugins.diff]
152                  default = ["walking"]
153                [plugins.linux]
154                  shim = "containerd-shim"
155                  runtime = "runc"
156                  runtime_root = ""
157                  no_shim = false
158                  shim_debug = false
159                [plugins.scheduler]
160                  pause_threshold = 0.02
161                  deletion_threshold = 0
162                  mutation_threshold = 100
163                  schedule_delay = 0
164                  startup_delay = 100000000
165
166
167

BUGS

169       Please   file   any   specific   issues   that   you    encounter    at
170       https://github.com/containerd/containerd.
171
172

AUTHOR

174       Phil Estes estesp@gmail.com ⟨mailto:estesp@gmail.com⟩
175
176