Version information
This version is compatible with:
- Puppet Enterprise 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 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
- , , , , ,
Tasks:
- scrub
Start using this module
Add this module to your Puppetfile:
mod 'bodgit-zfs', '3.0.0'Learn more about managing modules with a PuppetfileDocumentation
zfs
Table of Contents
- Description
- Setup - The basics of getting started with zfs
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Description
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.
Setup
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
Usage
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
Reference
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.
Limitations
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
Development
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.
Reference
Table of Contents
Classes
zfs: Installs basic ZFS kernel and userland support.zfs::configzfs::installzfs::servicezfs::zed: Installs the ZFS Event Daemon.zfs::zed::configzfs::zed::installzfs::zed::service
Defined types
zfs::scrub: Set up a zpool scrub cron entry.zfs::zed::zedlet: Enables either a packaged or custom ZFS Event Daemon "zedlet". Not specifying either$contentor$sourceresults in the zedlet being sym
Tasks
scrub: Allows you to initiate the scrub of a zpool
Classes
zfs
Installs basic ZFS kernel and userland support.
- See also
- puppet_classes::zfs::zed
- zfs::zed
- puppet_defined_types::zfs::scrub
- zfs::scrub
- puppet_classes::zfs::zed
Examples
Declaring the class
include zfs
Tuning the ZFS ARC
class { 'zfs':
zfs_arc_max => to_bytes('256 M'),
zfs_arc_min => to_bytes('128 M'),
}
Parameters
The following parameters are available in the zfs class:
conf_dir
Data type: Stdlib::Absolutepath
Top-level configuration directory, usually /etc/zfs.
kmod_type
Data type: Enum['dkms', 'kabi']
Whether to use DKMS kernel packages or ones built to match the running kernel (only applies to RHEL platforms).
manage_repo
Data type: Boolean
Whether to setup and manage external package repositories.
package_name
Data type: Variant[String, Array[String, 1]]
The name of the top-level metapackage that installs ZFS support.
service_manage
Data type: Boolean
Whether to manage the various ZFS services.
zfs_arc_max
Data type: Optional[Integer[0]]
Maximum size of the ARC in bytes.
zfs_arc_min
Data type: Optional[Integer[0]]
Minimum size of the ARC in bytes.
zfs::config
The zfs::config class.
zfs::install
The zfs::install class.
zfs::service
The zfs::service class.
zfs::zed
Installs the ZFS Event Daemon.
-
Since 2.0.0
-
See also
- puppet_classes::zfs
- zfs
- puppet_defined_types::zfs::zed::zedlet
- zfs::zed::zedlet
- puppet_classes::zfs
Examples
Declaring the class
include zfs
include zfs::zed
Parameters
The following parameters are available in the zfs::zed class:
conf_dirdebug_logemail_addrsemail_optsemail_proglock_dirnotify_interval_secsnotify_verbosepackage_namepushbullet_access_tokenpushbullet_channel_tagrun_dirservice_manageservice_namespare_on_checksum_errorsspare_on_io_errorssyslog_prioritysyslog_taguse_enclosure_ledszedlet_dirzedlets
conf_dir
Data type: Stdlib::Absolutepath
Configuration directory, usually ${zfs::conf_dir}/zed.d.
debug_log
Data type: Optional[Stdlib::Absolutepath]
email_addrs
Data type: Optional[Array[String, 1]]
email_opts
Data type: Optional[String]
email_prog
Data type: Optional[String]
lock_dir
Data type: Optional[Stdlib::Absolutepath]
notify_interval_secs
Data type: Optional[Integer[0]]
notify_verbose
Data type: Optional[Boolean]
package_name
Data type: Optional[String]
The name of the package to install if not installed already by the ZFS class.
pushbullet_access_token
Data type: Optional[String]
pushbullet_channel_tag
Data type: Optional[String]
run_dir
Data type: Optional[Stdlib::Absolutepath]
service_manage
Data type: Boolean
Whether to manage the service.
service_name
Data type: String
Name of the service.
spare_on_checksum_errors
Data type: Optional[Integer[1]]
spare_on_io_errors
Data type: Optional[Integer[1]]
syslog_priority
Data type: Optional[String]
syslog_tag
Data type: Optional[String]
use_enclosure_leds
Data type: Optional[Boolean]
zedlet_dir
Data type: Stdlib::Absolutepath
Path to package-provided zedlets.
zedlets
Data type: Hash[String, Hash]
Hash of zedlet resources to create.
zfs::zed::config
The zfs::zed::config class.
zfs::zed::install
The zfs::zed::install class.
zfs::zed::service
The zfs::zed::service class.
Defined types
zfs::scrub
Set up a zpool scrub cron entry.
-
Since 2.2.0
-
See also
- puppet_classes::zfs
- zfs
- puppet_classes::zfs
Examples
Scrub a zpool once a month
include zfs
zfs::scrub { 'test':
hour => '1',
minute => '0',
month => '*',
monthday => '1',
weekday => '*',
}
Parameters
The following parameters are available in the zfs::scrub defined type:
zpool
Data type: String
The name of the zpool.
Default value: $title
hour
Data type: Any
See the cron resource type.
minute
Data type: Any
See the cron resource type.
month
Data type: Any
See the cron resource type.
monthday
Data type: Any
See the cron resource type.
weekday
Data type: Any
See the cron resource type.
user
Data type: String
See the cron resource type.
Default value: 'root'
zfs::zed::zedlet
Enables either a packaged or custom ZFS Event Daemon "zedlet".
Not specifying either $content or $source results in the zedlet being
symlinked from the "installed zedlets" directory.
-
Since 2.0.0
-
See also
- puppet_classes::zfs::zed
- zfs::zed
- puppet_classes::zfs::zed
Examples
Enabling a packaged zedlet
zfs::zed::zedlet { 'scrub.finish-notify.sh': }
Enabling a custom zedlet
zfs::zed::zedlet { 'scrub.finish-notify.sh':
source => 'puppet:///example/scrub.finish-notify.sh',
}
Parameters
The following parameters are available in the zfs::zed::zedlet defined type:
content
Data type: Optional[String]
Content of custom zedlet
Default value: undef
source
Data type: Optional[String]
Source of custom zedlet
Default value: undef
zedlet
Data type: String
The filename for the zedlet
Default value: $title
Tasks
scrub
Allows you to initiate the scrub of a zpool
Supports noop? false
Parameters
zpool
Data type: String[1]
Name of the zpool
What are tasks?
Modules can contain tasks that take action outside of a desired state managed by Puppet. It’s perfect for troubleshooting or deploying one-off changes, distributing scripts to run across your infrastructure, or automating changes that need to happen in a particular order as part of an application deployment.
Tasks in this module release
Change log
All notable changes to this project will be documented in this file. The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
v3.0.0 (2021-06-24)
Changed
Added
v2.2.9 (2020-04-25)
Fixed
v2.2.8 (2020-02-19)
Added
v2.2.7 (2019-12-19)
v2.2.6 (2019-10-07)
v2.2.5 (2019-09-28)
Added
- Drop librarian and install fixtures manually #19 (bodgit)
- Manage ZFS YUM repo and RPM GPG key #15 (runejuhl)
- Install linux headers meta package on Debian #14 (sergiik)
v2.2.4 (2019-08-18)
Added
v2.2.3 (2018-02-24)
v2.2.2 (2018-01-17)
v2.2.1 (2017-11-03)
v2.2.0 (2017-11-02)
v2.1.0 (2017-10-31)
Added
- Add ability to manage ZED_USE_ENCLOSURE_LEDS setting in zed.rc template #4 (millerjl1701)
v2.0.1 (2017-10-16)
v2.0.0 (2017-01-07)
* This Changelog was automatically generated by github_changelog_generator
Dependencies
- puppetlabs/stdlib (>=4.13.0 <8.0.0)
- puppet/kmod (>=3.0.0 <4.0.0)
- puppetlabs/yumrepo_core (>=1.0.2 <2.0.0)
- puppetlabs/cron_core (>=1.0.0 <2.0.0)
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright 2013 Puppet Labs
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.