github.com/containerd/Containerd@v1.4.13/docs/man/containerd-config.toml.5.md (about)

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