Adoptable Cookbooks List

Looking for a cookbook to adopt? You can now see a list of cookbooks available for adoption!
List of Adoptable Cookbooks

Supermarket Belongs to the Community

Supermarket belongs to the community. While Chef has the responsibility to keep it running and be stewards of its functionality, what it does and how it works is driven by the community. The chef/supermarket repository will continue to be where development of the Supermarket application takes place. Come be part of shaping the direction of Supermarket by opening issues and pull requests or by joining us on the Chef Mailing List.

Select Badges

Select Supported Platforms

RSS

zfsonlinux (1) Versions 1.0.0

Installs/Configures ZFS on Linux.

Berkshelf/Librarian
Policyfile
Knife
cookbook 'zfsonlinux', '~> 1.0.0'
cookbook 'zfsonlinux', '~> 1.0.0', :supermarket
knife cookbook site install zfsonlinux
knife cookbook site download zfsonlinux
README
Dependencies
Changelog
Quality

zfsonlinux Cookbook

Build Status

Table of Contents

  1. Overview
  2. Requirements
  3. Attributes
  4. Usage
  5. Contributing
  6. License & Authors

Overview

This module manages the installation and configuration of ZFS on Linux.

Requirements

  • Chef 12.5+
  • yum Cookbook.
  • yum-epel Cookbook.

Attributes

Key Type Description Default
['zfsonlinux']['manage_repo'] Boolean Determines if Chef should manage the Yum repos for ZFS on Linux or not as well as the EPEL repo on DKMS installs. true
['zfsonlinux']['repo']['el']['type'] String Determines if dkms or kmod kernel modules should be used. If you are using the stock Red Hat kernel kmod is recommended. The default is set to dksm as this will work on any system by default. dkms
['zfsonlinux']['kmod']['modprobe'] Boolean Determines if when using the kmod installation method if the kernel module should be loaded by Chef or not. true

Usage

This cookbook can:

  • Optionally sets up the ZFS on Linux (and EPEL if using the dkms style install) repo.
  • Installs dependencies is using the dkms style install.
  • Installs the ZFS package.
  • Can manage zpools.
  • Can manage datasets.

A minimal default install (managed repos using dkms):

include_recipe 'zfsonlinux::default'

Using the kmod style install:

node.default['zfsonlinux']['repo']['el']['type'] = 'kmod'

include_recipe 'zfsonlinux::default'

zfsonlinux_zpool

To create a zpool:

zfsonlinux_zpool 'morpheus' do
  vdevs ['/dev/sdb', '/dev/sdc']
end

To destroy a zpool:

zfsonlinux_zpool 'morpheus' do
  action :destroy
end

NOTE: This resource currently only supports striped zpools.

zfsonlinux_dataset

To create a dataset with default properties:

zfsonlinux_dataset 'morpheus/nebuchadnezzar'

NOTE: You should ensure the parent zpool exists before creating a dataset on it.

To create a dataset with non-default properties:

zfsonlinux_dataset 'morpheus/nebuchadnezzar' do
  properties mountpoint: '/ship'
             compress: 'lz4'
end

To remove a dataset without children:

zfsonlinux_dataset 'morpheus/nebuchadnezzar' do
  action :destroy
end

To remove a dataset with children:

zfsonlinux_dataset 'morpheus/nebuchadnezzar' do
  remove_children true
  action :destroy
end

Contributing

If you would like to contribute to this cookbook please follow these steps;

  1. Fork the repository on Github.
  2. Create a named feature branch (like add_component_x).
  3. Write your change.
  4. Write tests for your change (if applicable).
  5. Write documentation for your change (if applicable).
  6. Run the tests, ensuring they all pass.
  7. Submit a Pull Request using GitHub.

License and Authors

License: BSD 2-Clause

Authors:

Dependent cookbooks

yum-epel >= 0.7.0
yum >= 3.5.2

Contingent cookbooks

There are no cookbooks that are contingent upon this one.

2016-11-27 (v1.0.0)

Summary

Initial release.

Features

  • Optionally set-up ZFS on Linux repos (EL 6 & 7 supported.)
  • Install ZFS package (dkms & kmod supported).
  • Optionally enable the zfs kernel module.
  • Custom resources for:
    • zpools (zfsonlinux_zpool) - striped zpools only at this time.
    • datasets (zfsonlinux_dataset)

Collaborator Number Metric
            

1.0.0 failed this metric

Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.

Contributing File Metric
            

1.0.0 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file

Foodcritic Metric
            

1.0.0 passed this metric

License Metric
            

1.0.0 failed this metric

zfsonlinux does not have a valid open source license.
Acceptable licenses include Apache-2.0, apachev2, Apache 2.0, MIT, mit, GPL-2.0, gplv2, GNU Public License 2.0, GPL-3.0, gplv3, GNU Public License 3.0.

No Binaries Metric
            

1.0.0 failed this metric

Failure: Cookbook should not contain binaries. Found:
zfsonlinux/files/default/gpg.key

Publish Metric
            

1.0.0 passed this metric

Supported Platforms Metric
            

1.0.0 passed this metric

Testing File Metric
            

1.0.0 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file

Version Tag Metric
            

1.0.0 passed this metric