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

EXAMPLE

134       The following is a complete config.toml default configuration example:
135
136
137              root = "/var/lib/containerd"
138              state = "/run/containerd"
139              oom_score = 0
140              imports = ["/etc/containerd/runtime_*.toml", "./debug.toml"]
141
142              [grpc]
143                address = "/run/containerd/containerd.sock"
144                uid = 0
145                gid = 0
146
147              [debug]
148                address = "/run/containerd/debug.sock"
149                uid = 0
150                gid = 0
151                level = "info"
152
153              [metrics]
154                address = ""
155                grpc_histogram = false
156
157              [cgroup]
158                path = ""
159
160              [plugins]
161                [plugins.cgroups]
162                  no_prometheus = false
163                [plugins.diff]
164                  default = ["walking"]
165                [plugins.linux]
166                  shim = "containerd-shim"
167                  runtime = "runc"
168                  runtime_root = ""
169                  no_shim = false
170                  shim_debug = false
171                [plugins.scheduler]
172                  pause_threshold = 0.02
173                  deletion_threshold = 0
174                  mutation_threshold = 100
175                  schedule_delay = 0
176                  startup_delay = "100ms"
177
178
179

BUGS

181       Please    file    any   specific   issues   that   you   encounter   at
182       https://github.com/containerd/containerd.
183
184

AUTHOR

186       Phil Estes estesp@gmail.com ⟨mailto:estesp@gmail.com⟩
187
188

SEE ALSO

190       ctr(8), containerd-config(8), containerd(8)
191
192
193
194                                  08/08/2018    /etc/containerd/config.toml(5)
Impressum