zfs

README

containerd ZFS snapshotter plugin

ZFS snapshotter plugin for containerd.

This plugin is tested on Linux with Ubuntu. It should be compatible with FreeBSD.

Usage

The plugin is built-in by default since containerd 1.1. No need to recompile containerd or execute a proxy snapshotter process.

1. Set up a ZFS filesystem. The ZFS filesystem name is arbitrary but the mount point needs to be /var/lib/containerd/io.containerd.snapshotter.v1.zfs, when the containerd root is set to /var/lib/containerd.

$ zfs create -o mountpoint=/var/lib/containerd/io.containerd.snapshotter.v1.zfs your-zpool/containerd

1. Start containerd.

2. e.g. ctr pull --snapshotter=zfs ...

Project details

The zfs plugin is a containerd sub-project, licensed under the Apache 2.0 license. As a containerd sub-project, you will find the:

• Project governance,
• Maintainers,
• and Contributing guidelines

information in our containerd/project repository.

Documentation

Index

• func NewSnapshotter(root string) (snapshots.Snapshotter, error)

Functions

func NewSnapshotter

func NewSnapshotter(root string) (snapshots.Snapshotter, error)

NewSnapshotter returns a Snapshotter using zfs. Uses the provided root directory for snapshots and stores the metadata in a file in the provided root. root needs to be a mount point of zfs.