Puppet Module for managing ZFS

Matt Dainty



159 latest version

5.0 quality score

Version information

  • 3.0.0 (latest)
  • 2.2.9
  • 2.2.8
  • 2.2.7
  • 2.2.6
  • 2.2.5
  • 2.2.4
  • 2.2.3
  • 2.2.2
  • 2.2.1
  • 2.2.0
  • 2.1.0
  • 2.0.1
  • 2.0.0
  • 1.0.0
released Jun 24th 2021
This version is compatible with:
  • Puppet Enterprise 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x
  • Puppet >=5.5.10 <8.0.0
  • RedHat
  • scrub

Start using this module

Tags: zfs, zpool, zed


bodgit/zfs — version 3.0.0 Jun 24th 2021


Build Status Codecov Puppet Forge version Puppet Forge downloads Puppet Forge - PDK version

Table of Contents

  1. Description
  2. Setup - The basics of getting started with zfs
  3. Usage - Configuration options and additional functionality
  4. Reference - An under-the-hood peek at what the module is doing and how
  5. Limitations - OS compatibility, etc.
  6. Development - Guide for contributing to the module


This module currently ensures that the ZFS packages available from zfsonlinux.org are installed and configured.

RHEL/CentOS, Ubuntu and Debian are supported using Puppet 5 or later. On RHEL/CentOS platforms there is support for installing the kABI-tracking kernel modules as opposed to the default of DKMS-style kernel modules.


What zfs affects

This module will install kernel modules which utilises the DKMS framework to accomplish this. This means kernel headers, toolchains, etc. will be installed.

Setup Requirements

You will need pluginsync enabled. On RHEL/CentOS platforms you will need to have access to the EPEL repository by using puppet/epel or by other means to use the DKMS-style kernel modules. On Debian you will need to enable backports using puppetlabs/apt with something like:

class { 'apt::backports':
  repos  => 'main contrib',
  pin    => 990,
  before => Class['zfs'],

Beginning with zfs

In the very simplest case, you can just include the following:

include zfs


For example on RHEL/CentOS to instead install the kABI-tracking kernel modules and tune the ARC, you can do:

class { 'zfs':
  kmod_type   => 'kabi',
  zfs_arc_max => to_bytes('256 M'),
  zfs_arc_min => to_bytes('128 M'),

To also install the ZFS Event Daemon (zed):

include zfs
include zfs::zed


The reference documentation is generated with puppet-strings and the latest version of the documentation is hosted at https://bodgit.github.io/puppet-zfs/ and available also in the REFERENCE.md.


This module has been built on and tested against Puppet 5 and higher.

The module has been tested on:

  • Red Hat/CentOS Enterprise Linux 6/7/8
  • Ubuntu 16.04/18.04/20.04
  • Debian 9/10


The module relies on PDK and has both rspec-puppet and Litmus tests. Run them with:

$ bundle exec rake spec
$ bundle exec rake litmus:*

Please log issues or pull requests at github.