{"id":15517538,"url":"https://github.com/bodgit/puppet-zfs","last_synced_at":"2025-08-01T00:05:24.328Z","repository":{"id":24463181,"uuid":"27866451","full_name":"bodgit/puppet-zfs","owner":"bodgit","description":"Puppet Module for managing ZFS","archived":false,"fork":false,"pushed_at":"2021-06-24T10:45:49.000Z","size":299,"stargazers_count":6,"open_issues_count":0,"forks_count":10,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-17T19:17:37.313Z","etag":null,"topics":["puppet","zfs","zpool","zpool-scrub"],"latest_commit_sha":null,"homepage":"https://forge.puppet.com/bodgit/zfs","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bodgit.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-12-11T10:41:08.000Z","updated_at":"2021-07-18T02:09:54.000Z","dependencies_parsed_at":"2022-08-22T08:20:42.475Z","dependency_job_id":null,"html_url":"https://github.com/bodgit/puppet-zfs","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bodgit%2Fpuppet-zfs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bodgit%2Fpuppet-zfs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bodgit%2Fpuppet-zfs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bodgit%2Fpuppet-zfs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bodgit","download_url":"https://codeload.github.com/bodgit/puppet-zfs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250366687,"owners_count":21418768,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["puppet","zfs","zpool","zpool-scrub"],"created_at":"2024-10-02T10:13:43.686Z","updated_at":"2025-04-23T03:51:58.311Z","avatar_url":"https://github.com/bodgit.png","language":"Ruby","readme":"# zfs\n\n[![Build Status](https://img.shields.io/github/workflow/status/bodgit/puppet-zfs/Test)](https://github.com/bodgit/puppet-zfs/actions?query=workflow%3ATest)\n[![Codecov](https://img.shields.io/codecov/c/github/bodgit/puppet-zfs)](https://codecov.io/gh/bodgit/puppet-zfs)\n[![Puppet Forge version](http://img.shields.io/puppetforge/v/bodgit/zfs)](https://forge.puppetlabs.com/bodgit/zfs)\n[![Puppet Forge downloads](https://img.shields.io/puppetforge/dt/bodgit/zfs)](https://forge.puppetlabs.com/bodgit/zfs)\n[![Puppet Forge - PDK version](https://img.shields.io/puppetforge/pdk-version/bodgit/zfs)](https://forge.puppetlabs.com/bodgit/zfs)\n\n#### Table of Contents\n\n1. [Description](#description)\n2. [Setup - The basics of getting started with zfs](#setup)\n    * [What zfs affects](#what-zfs-affects)\n    * [Setup requirements](#setup-requirements)\n    * [Beginning with zfs](#beginning-with-zfs)\n3. [Usage - Configuration options and additional functionality](#usage)\n4. [Reference - An under-the-hood peek at what the module is doing and how](#reference)\n5. [Limitations - OS compatibility, etc.](#limitations)\n6. [Development - Guide for contributing to the module](#development)\n\n## Description\n\nThis module currently ensures that the ZFS packages available from\n[zfsonlinux.org](http://zfsonlinux.org) are installed and configured.\n\nRHEL/CentOS, Ubuntu and Debian are supported using Puppet 5 or later. On\nRHEL/CentOS platforms there is support for installing the kABI-tracking kernel\nmodules as opposed to the default of DKMS-style kernel modules.\n\n## Setup\n\n### What zfs affects\n\nThis module will install kernel modules which utilises the DKMS framework to\naccomplish this. This means kernel headers, toolchains, etc. will be installed.\n\n### Setup Requirements\n\nYou will need pluginsync enabled. On RHEL/CentOS platforms you will need to\nhave access to the EPEL repository by using\n[puppet/epel](https://forge.puppet.com/puppet/epel) or by other means to\nuse the DKMS-style kernel modules. On Debian you will need to enable\nbackports using\n[puppetlabs/apt](https://forge.puppet.com/puppetlabs/apt) with something like:\n\n```puppet\nclass { 'apt::backports':\n  repos  =\u003e 'main contrib',\n  pin    =\u003e 990,\n  before =\u003e Class['zfs'],\n}\n```\n\n### Beginning with zfs\n\nIn the very simplest case, you can just include the following:\n\n```puppet\ninclude zfs\n```\n\n## Usage\n\nFor example on RHEL/CentOS to instead install the kABI-tracking kernel modules\nand tune the ARC, you can do:\n\n```puppet\nclass { 'zfs':\n  kmod_type   =\u003e 'kabi',\n  zfs_arc_max =\u003e to_bytes('256 M'),\n  zfs_arc_min =\u003e to_bytes('128 M'),\n}\n```\n\nTo also install the ZFS Event Daemon (zed):\n\n```puppet\ninclude zfs\ninclude zfs::zed\n```\n\n## Reference\n\nThe reference documentation is generated with\n[puppet-strings](https://github.com/puppetlabs/puppet-strings) and the latest\nversion of the documentation is hosted at\n[https://bodgit.github.io/puppet-zfs/](https://bodgit.github.io/puppet-zfs/)\nand available also in the [REFERENCE.md](https://github.com/bodgit/puppet-zfs/blob/main/REFERENCE.md).\n\n## Limitations\n\nThis module has been built on and tested against Puppet 5 and higher.\n\nThe module has been tested on:\n\n* Red Hat/CentOS Enterprise Linux 6/7/8\n* Ubuntu 16.04/18.04/20.04\n* Debian 9/10\n\n## Development\n\nThe module relies on [PDK](https://puppet.com/docs/pdk/1.x/pdk.html) and has\nboth [rspec-puppet](http://rspec-puppet.com) and\n[Litmus](https://github.com/puppetlabs/puppet_litmus) tests. Run them\nwith:\n\n```\n$ bundle exec rake spec\n$ bundle exec rake litmus:*\n```\n\nPlease log issues or pull requests at\n[github](https://github.com/bodgit/puppet-zfs).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbodgit%2Fpuppet-zfs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbodgit%2Fpuppet-zfs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbodgit%2Fpuppet-zfs/lists"}