Skip to content

Commit

Permalink
Merge pull request #573 from ChengyuZhu6/config
Browse files Browse the repository at this point in the history
docs: Supplementary for containerd configuration required by snapshotter
  • Loading branch information
imeoer authored Jan 15, 2024
2 parents 47d4311 + 0041455 commit cc66508
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/run_nydus_in_kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down

0 comments on commit cc66508

Please sign in to comment.