github.com/demonoid81/containerd@v1.3.4/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  
    43  **[grpc]**
    44  : Section for gRPC socket listener settings. Contains three properties:
    45   - **address** (Default: "/run/containerd/containerd.sock")
    46   - **uid** (Default: 0)
    47   - **gid** (Default: 0)
    48  
    49  **[debug]**
    50  : Section to enable and configure a debug socket listener. Contains four properties:
    51   - **address** (Default: "/run/containerd/debug.sock")
    52   - **uid** (Default: 0)
    53   - **gid** (Default: 0)
    54   - **level** (Default: "info") sets the debug log level
    55  
    56  **[metrics]**
    57  : Section to enable and configure a metrics listener. Contains two properties:
    58   - **address** (Default: "") Metrics endpoint does not listen by default
    59   - **grpc_histogram** (Default: false) Turn on or off gRPC histogram metrics
    60  
    61  **[cgroup]**
    62  : Section for Linux cgroup specific settings
    63   - **path** (Default: "") Specify a custom cgroup path for created containers
    64  
    65  **[plugins]**
    66  : The plugins section contains configuration options exposed from installed plugins.
    67  The following plugins are enabled by default and their settings are shown below.
    68  Plugins that are not enabled by default will provide their own configuration values
    69  documentation.
    70   - **[plugins.cgroup]** has one option __no_prometheus__ (Default: **false**)
    71   - **[plugins.diff]** has one option __default__, a list by default set to **["walking"]**
    72   - **[plugins.linux]** has several options for configuring the runtime, shim, and related options:
    73     **shim** specifies the shim binary (Default: **"containerd-shim"**),
    74     **runtime** is the OCI compliant runtime binary (Default: **"runc"**),
    75     **runtime_root** is the root directory used by the runtime (Default: **""**),
    76     **no_shim** specifies whether to use a shim or not (Default: **false**),
    77     **shim_debug** turns on debugging for the shim (Default: **false**)
    78   - **[plugins.scheduler]** has several options that perform advanced tuning for the scheduler:
    79     **pause_threshold** is the maximum amount of time GC should be scheduled (Default: **0.02**),
    80     **deletion_threshold** guarantees GC is scheduled after n number of deletions (Default: **0** [not triggered]),
    81     **mutation_threshold** guarantees GC is scheduled after n number of database mutations (Default: **100**),
    82     **schedule_delay** defines the delay after trigger event before scheduling a GC (Default **"0ms"** [immediate]),
    83     **startup_delay** defines the delay after startup before scheduling a GC (Default **"100ms"**)
    84  
    85  ## EXAMPLE
    86  
    87  The following is a complete **config.toml** default configuration example:
    88  
    89  ```
    90  root = "/var/lib/containerd"
    91  state = "/run/containerd"
    92  oom_score = 0
    93  imports = ["/etc/containerd/runtime_*.toml", "./debug.toml"]
    94  
    95  [grpc]
    96    address = "/run/containerd/containerd.sock"
    97    uid = 0
    98    gid = 0
    99  
   100  [debug]
   101    address = "/run/containerd/debug.sock"
   102    uid = 0
   103    gid = 0
   104    level = "info"
   105  
   106  [metrics]
   107    address = ""
   108    grpc_histogram = false
   109  
   110  [cgroup]
   111    path = ""
   112  
   113  [plugins]
   114    [plugins.cgroups]
   115      no_prometheus = false
   116    [plugins.diff]
   117      default = ["walking"]
   118    [plugins.linux]
   119      shim = "containerd-shim"
   120      runtime = "runc"
   121      runtime_root = ""
   122      no_shim = false
   123      shim_debug = false
   124    [plugins.scheduler]
   125      pause_threshold = 0.02
   126      deletion_threshold = 0
   127      mutation_threshold = 100
   128      schedule_delay = 0
   129      startup_delay = 100000000
   130  ```
   131  
   132  ## BUGS
   133  
   134  Please file any specific issues that you encounter at
   135  https://github.com/containerd/containerd.
   136  
   137  ## AUTHOR
   138  
   139  Phil Estes <estesp@gmail.com>
   140  
   141  ## SEE ALSO
   142  
   143  ctr(8), containerd-config(8), containerd(8)