dmcgowan / zfs

ZFS snapshotter plugin for containerd

containerd ZFS snapshotter plugin

ZFS snapshotter plugin for containerd.

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

Compile

To compile containerd with ZFS support, add the import into the $GOPATH/src/github.com/containerd/containerd/cmd/containerd/builtins_zfs.go file.

// +build linux freebsd

package main

import (
        _ "github.com/containerd/zfs"
)

Please refer to .travis.yml for the latest containerd version known to work with.

Usage

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

2. Start containerd.

3. 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.