https://github.com/containerd/zfs

ZFS snapshotter plugin for containerd
https://github.com/containerd/zfs

containerd zfs

Last synced: about 1 month ago
JSON representation

ZFS snapshotter plugin for containerd

• Host: GitHub
• URL: https://github.com/containerd/zfs
• Owner: containerd
• License: apache-2.0
• Created: 2017-06-27T08:54:50.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-10-24T15:33:17.000Z (about 2 months ago)
• Last Synced: 2024-10-25T16:08:20.870Z (about 2 months ago)
• Topics: containerd, zfs
• Language: Go
• Size: 3.33 MB
• Stars: 68
• Watchers: 17
• Forks: 29
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-repositories - containerd/zfs - ZFS snapshotter plugin for containerd (Go)

README

        
# [containerd](https://github.com/containerd/containerd) ZFS snapshotter plugin

[![PkgGoDev](https://pkg.go.dev/badge/github.com/containerd/zfs)](https://pkg.go.dev/github.com/containerd/zfs)

[![Build Status](https://github.com/containerd/zfs/actions/workflows/ci.yml/badge.svg)](https://github.com/containerd/zfs/actions/workflows/ci.yml)

[![Go Report Card](https://goreportcard.com/badge/github.com/containerd/zfs)](https://goreportcard.com/report/github.com/containerd/zfs)

[![codecov](https://codecov.io/gh/containerd/zfs/branch/main/graph/badge.svg)](https://codecov.io/gh/containerd/zfs)

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

```console

$ 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](./LICENSE).

As a containerd sub-project, you will find the:

 * [Project governance](https://github.com/containerd/project/blob/main/GOVERNANCE.md),

 * [Maintainers](https://github.com/containerd/project/blob/main/MAINTAINERS),

 * and [Contributing guidelines](https://github.com/containerd/project/blob/main/CONTRIBUTING.md)

information in our [`containerd/project`](https://github.com/containerd/project) repository.