From 493baa6e7cd049691afa939d9f236df38db1ae52 Mon Sep 17 00:00:00 2001 From: Akihiro Suda Date: Tue, 5 Apr 2022 18:11:59 +0900 Subject: [PATCH] Add docs/snapshots Signed-off-by: Akihiro Suda --- docs/snapshotters/README.md | 26 +++++++++++++++++++ .../snapshotters/devmapper.md | 0 2 files changed, 26 insertions(+) create mode 100644 docs/snapshotters/README.md rename snapshots/devmapper/README.md => docs/snapshotters/devmapper.md (100%) diff --git a/docs/snapshotters/README.md b/docs/snapshotters/README.md new file mode 100644 index 000000000..d4d892eec --- /dev/null +++ b/docs/snapshotters/README.md @@ -0,0 +1,26 @@ +# Snapshotters + +Snapshotters manage the snapshots of the container filesystems. + +The available snapshotters can be inspected by running `ctr plugins ls` or `nerdctl info`. + +## Core snapshotter plugins + +Generic: +- `overlayfs` (default): OverlayFS. This driver is akin to Docker/Moby's "overlay2" storage driver, but containerd's implementation is not called "overlay2". +- `native`: Native file copying driver. Akin to Docker/Moby's "vfs" driver. + +Filesystem-specific: +- `btrfs`: btrfs. Needs the plugin root (`/var/lib/containerd/io.containerd.snapshotter.v1.btrfs`) to be mounted as btrfs. +- `zfs`: ZFS. Needs the plugin root (`/var/lib/containerd/io.containerd.snapshotter.v1.zfs`) to be mounted as ZFS. See also https://github.com/containerd/zfs . +- `devmapper`: ext4/xfs device mapper. See [`devmapper.md`](./devmapper.md). + +[Deprecated](https://github.com/containerd/containerd/blob/main/RELEASES.md#deprecated-features): +- `aufs`: AUFS. Deprecated since containerd 1.5. Planned to be removed in containerd 2.0. See also https://github.com/containerd/aufs . + +## Non-core snapshotter plugins + +- `fuse-overlayfs`: [FUSE-OverlayFS Snapshotter](https://github.com/containerd/fuse-overlayfs-snapshotter) +- `nydus`: [Nydus Snapshotter](https://github.com/containerd/nydus-snapshotter) +- `overlaybd`: [OverlayBD Snapshotter](https://github.com/containerd/accelerated-container-image) +- `stargz`: [Stargz Snapshotter](https://github.com/containerd/stargz-snapshotter) diff --git a/snapshots/devmapper/README.md b/docs/snapshotters/devmapper.md similarity index 100% rename from snapshots/devmapper/README.md rename to docs/snapshotters/devmapper.md