From 224efa9daec5760b0944da8719056deb62c1bd28 Mon Sep 17 00:00:00 2001 From: Emmanuel Ramos Date: Thu, 25 Feb 2021 12:54:23 -0500 Subject: [PATCH] Fixed wording in docs, and broken link Signed-off-by: Emmanuel Ramos --- docs/PLUGINS.md | 4 ++-- docs/ops.md | 4 +++- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/PLUGINS.md b/docs/PLUGINS.md index 42cc87bd8..f45297ce8 100644 --- a/docs/PLUGINS.md +++ b/docs/PLUGINS.md @@ -21,7 +21,7 @@ External plugins allow extending containerd's functionality using an officially released version of containerd without needing to recompile the daemon to add a plugin. -containerd allows extensions through two method: +containerd allows extensions through two methods: - via a binary available in containerd's PATH - by configuring containerd to proxy to another gRPC service @@ -32,7 +32,7 @@ These binaries are used to start the shim process for containerd and allows containerd to manage those containers using the runtime shim api returned by the binary. -See [runtime v2 documentation](runtime/v2/README.md) +See [runtime v2 documentation](../runtime/v2/README.md) ### Proxy Plugins diff --git a/docs/ops.md b/docs/ops.md index 56f92534c..320b77dc4 100644 --- a/docs/ops.md +++ b/docs/ops.md @@ -79,7 +79,7 @@ sudo systemd-run -p Delegate=yes -p KillMode=process /usr/local/bin/containerd In the containerd config file you will find settings for persistent and runtime storage locations as well as grpc, debug, and metrics addresses for the various APIs. There are a few settings that are important for ops. -The first setting is the `oom_score`. Because containerd will be managing multiple containers, we need to ensure that containers are killed before the containerd daemon in an out of memory condition. +The first setting is the `oom_score`. Because containerd will be managing multiple containers, we need to ensure that containers are killed before the containerd daemon gets into an out of memory condition. We also do not want to make containerd unkillable, but we want to lower its score to the level of other system daemons. containerd also exports its own metrics as well as container level metrics via the prometheus metrics format. @@ -196,6 +196,8 @@ The only way we can do this is via the config file and not CLI flags. In the config file you can specify plugin level options for the set of plugins that you use via the `[plugins.]` sections. You will have to read the plugin specific docs to find the options that your plugin accepts. +See [containerd's Plugin documentation](./PLUGINS.md) + ### Linux Runtime Plugin The linux runtime allows a few options to be set to configure the shim and the runtime that you are using.