github/containerd
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

Merge pull request #6207 from marquiz/devel/docs

Browse Source 
docs: improve plugin documentation
This commit is contained in:
Derek McGowan 2022-01-03 13:20:29 -08:00 committed by GitHub
commit 07aa42f427
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 54 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
docs/man/containerd-config.toml.5.md
View File

@ -38,12 +38,9 @@ config as version 1 has been deprecated.
**plugin_dir**
: The directory for dynamic plugins to be stored
**sched_core**
: Core scheduling is a feature that allows only trusted tasks to run concurrently
on cpus sharing compute resources (eg: hyperthreads on a core).
**[grpc]**
: Section for gRPC socket listener settings. Contains the following properties:
- **address** (Default: "/run/containerd/containerd.sock")
- **tcp_address**
- **tcp_tls_cert**
@ -55,12 +52,14 @@ on cpus sharing compute resources (eg: hyperthreads on a core).
**[ttrpc]**
: Section for TTRPC settings. Contains properties:
- **address** (Default: "")
- **uid** (Default: 0)
- **gid** (Default: 0)
**[debug]**
: Section to enable and configure a debug socket listener. Contains four properties:
- **address** (Default: "/run/containerd/debug.sock")
- **uid** (Default: 0)
- **gid** (Default: 0)
@ -68,6 +67,7 @@ on cpus sharing compute resources (eg: hyperthreads on a core).
**[metrics]**
: Section to enable and configure a metrics listener. Contains two properties:
- **address** (Default: "") Metrics endpoint does not listen by default
- **grpc_histogram** (Default: false) Turn on or off gRPC histogram metrics
@ -84,30 +84,38 @@ required plugin doesn't exist or fails to be initialized or started.
The following plugins are enabled by default and their settings are shown below.
Plugins that are not enabled by default will provide their own configuration values
documentation.
- **[plugins.cgroup]** has one option __no_prometheus__ (Default: **false**)
- **[plugins.diff]** has one option __default__, a list by default set to **["walking"]**
- **[plugins.linux]** has several options for configuring the runtime, shim, and related options:
**shim** specifies the shim binary (Default: **"containerd-shim"**),
**runtime** is the OCI compliant runtime binary (Default: **"runc"**),
**runtime_root** is the root directory used by the runtime (Default: **""**),
**no_shim** specifies whether to use a shim or not (Default: **false**),
**shim_debug** turns on debugging for the shim (Default: **false**)
- **shim** specifies the shim binary (Default: **"containerd-shim"**),
- **runtime** is the OCI compliant runtime binary (Default: **"runc"**),
- **runtime_root** is the root directory used by the runtime (Default: **""**),
- **no_shim** specifies whether to use a shim or not (Default: **false**),
- **shim_debug** turns on debugging for the shim (Default: **false**)
- **[plugins."io.containerd.gc.v1.scheduler"]** has several options that perform advanced tuning for the scheduler:
**pause_threshold** is the maximum amount of time GC should be scheduled (Default: **0.02**),
**deletion_threshold** guarantees GC is scheduled after n number of deletions (Default: **0** [not triggered]),
**mutation_threshold** guarantees GC is scheduled after n number of database mutations (Default: **100**),
**schedule_delay** defines the delay after trigger event before scheduling a GC (Default **"0ms"** [immediate]),
**startup_delay** defines the delay after startup before scheduling a GC (Default **"100ms"**)
- **pause_threshold** is the maximum amount of time GC should be scheduled (Default: **0.02**),
- **deletion_threshold** guarantees GC is scheduled after n number of deletions (Default: **0** [not triggered]),
- **mutation_threshold** guarantees GC is scheduled after n number of database mutations (Default: **100**),
- **schedule_delay** defines the delay after trigger event before scheduling a GC (Default **"0ms"** [immediate]),
- **startup_delay** defines the delay after startup before scheduling a GC (Default **"100ms"**)
- **[plugins."io.containerd.runtime-shim.v2.shim"]** specifies options for configuring the runtime shim:
- **platforms** specifies the list of supported platforms
- **sched_core** Core scheduling is a feature that allows only trusted tasks
to run concurrently on cpus sharing compute resources (eg: hyperthreads on
a core). (Default: **false**)
**oom_score**
: The out of memory (OOM) score applied to the containerd daemon process (Default: 0)
**[cgroup]**
: Section for Linux cgroup specific settings
- **path** (Default: "") Specify a custom cgroup path for created containers
**[proxy_plugins]**
: Proxy plugins configures plugins which are communicated to over gRPC
- **type** (Default: "")
- **address** (Default: "")
@ -131,6 +139,7 @@ Imported files are also versioned, and the version can't be higher than
the main config.
**stream_processors**
- **accepts** (Default: "[]") Accepts specific media-types
- **returns** (Default: "") Returns the media-type
- **path** (Default: "") Path or name of the binary
@ -145,7 +154,6 @@ root = "/var/lib/containerd"
state = "/run/containerd"
oom_score = 0
imports = ["/etc/containerd/runtime_*.toml", "./debug.toml"]
sched_core = true
[grpc]
address = "/run/containerd/containerd.sock"
@ -182,6 +190,9 @@ sched_core = true
mutation_threshold = 100
schedule_delay = 0
startup_delay = "100ms"
[plugins."io.containerd.runtime-shim.v2.shim"]
platforms = ["linux/amd64"]
sched_core = true
```
## BUGS