Version information
This version is compatible with:
Start using this module
Add this module to your Puppetfile:
mod 'hackerhorse-zfs_freebsd', '0.1.2'
Learn more about managing modules with a PuppetfileDocumentation
zfs_freebsd
Table of Contents
- Description
- Setup - The basics
- Usage
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
- Contributors - whodunnit?
- Changelog
Description
zfs_freebsd is a basic module to allow for the creation/destruction of ZFS datasets. In the future, this module will support more functions, such as the creation of ZFS Volumes.
The original work on this module was done by @snonux on github. Further work is continued on a fork by @RainbowHackerHorse (That's me!)
Setup
Setup Requirements
You need to be running ZFS on a FreeBSD system. No other requirements are in place.
Usage
To start, simply download the module, and add something like:
zfs_freebsd::create { 'zroot/foobar': ensure => present, filesystem => '/foobar', }
Use ensure => absent
to destroy the dataset.
Limitations
This module is currently only available for use on FreeBSD, and only manages datasets currently. Future development will be implementing other ZFS features.
Development
You can contribute by forking https://github.com/RainbowHackerHorse/zfs_freebsd and opening a PR.
Contributors
- Snonux - Original author prior to fork
- Rainbow (RainbowHackerHorse)
Changelog
- 0.1.0 - Initial release
- 0.1.1 - Remove Scrub
Dependencies
- puppetlabs-stdlib (>= 4.20.0)
Original portions of this code written by @Snonux, and released public domain. Changes in this repo are released under the BSD 2-Clause License and opyright (c) 2017, RainbowHackerHorse All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.