From 00414555462436881332ff5c2f5b9c32e0fba23b Mon Sep 17 00:00:00 2001 From: ChengyuZhu6 Date: Fri, 12 Jan 2024 14:23:15 +0800 Subject: [PATCH] docs: Supplementary for containerd configuration required by nydus snapshotter Supplementary for containerd configuration required by nydus snapshotter: `disable_snapshot_annotations` and `discard_unpacked_layers`. Signed-off-by: ChengyuZhu6 --- docs/run_nydus_in_kubernetes.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/run_nydus_in_kubernetes.md b/docs/run_nydus_in_kubernetes.md index 3be8db40a1..582cbe1f38 100644 --- a/docs/run_nydus_in_kubernetes.md +++ b/docs/run_nydus_in_kubernetes.md @@ -34,6 +34,10 @@ nodes: Next, we also need a config for containerd(`containerd-config.toml`). +**NOTE:** It may be necessary to explain here why `disable_snapshot_annotations` and `discard_unpacked_layers` need to be configured in containerd. +- `disable_snapshot_annotations`: This variable disables to pass additional annotations (image related information) to snapshotters in containerd (default value is `true`). In nydus snapshotter, we need these annotations to pull images. Therefore, we need to set it to `false`. +- `discard_unpacked_layers`: This variable allows GC to remove layers from the content store after successfully unpacking these layers to the snapshotter in containerd (default value is `true`). In nydus snapshotter, we need to preserve layers for demand pulling and sharing even after they are unpacked. Therefore, we need to set it to `false`. + ```toml version = 2 [debug]