zfs_core
Version information
This version is compatible with:
- Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 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
- Puppet >= 6.0.0 < 9.0.0
- Solaris
Start using this module
Add this module to your Puppetfile:
mod 'puppetlabs-zfs_core', '1.6.1'
Learn more about managing modules with a PuppetfileDocumentation
zfs_core
Table of Contents
- Description
- 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
The zfs_core module is used to manage both zfs and zpool resources. Though This module is only tested on Solaris machines, it should also work on any machine that has zfs or zpool resources.
Usage
To create a zpool resource with the name tstpool
that uses the disk /ztstpool/dsk
, use the following code:
zpool { 'tstpool':
ensure => present,
disk => '/ztstpool/dsk',
}
To create a zfs resource based on the pool created above, use the following code:
zfs { 'tstpool/tstfs':
ensure => present,
}
Reference
Please see the REFERENCE.md documentation for the zfs_core
and zpool_core
modules.
This module is documented using Puppet Strings.
For a quick primer on how Strings works, please see this blog post or the README.md for Puppet Strings.
To generate documentation locally, run the following command:
bundle install
bundle exec puppet strings generate ./lib/**/*.rb
This command will create a browsable \_index.html
file in the doc
directory. The references available here are all generated from YARD-style comments embedded in the code base. When any development happens on this module, the impacted documentation should also be updated.
Limitations
This module is only available on platforms that have both zfs and zpool available.
Development
Puppet Labs modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can't access the huge number of platforms and myriad of hardware, software, and deployment configurations that Puppet is intended to serve.
We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.
For more information, see our module contribution guide.
Reference
Table of Contents
Resource types
zfs
: Manage zfs. Create destroy and set properties on zfs instances.zpool
: Manage zpools. Create and delete zpools. The provider WILL NOT SYNC, only report differences.
Resource types
zfs
Autorequires: If Puppet is managing the zpool at the root of this zfs instance, the zfs resource will autorequire it. If Puppet is managing any parent zfs instances, the zfs resource will autorequire them.
Examples
Using zfs.
zfs { 'tstpool':
ensure => present,
}
Properties
The following properties are available in the zfs
type.
aclinherit
The aclinherit property. Valid values are discard
, noallow
, restricted
, passthrough
, passthrough-x
.
aclmode
The aclmode property. Valid values are discard
, groupmask
, passthrough
.
acltype
The acltype propery. Valid values are 'noacl' and 'posixacl'. Only supported on Linux.
atime
The atime property. Valid values are on
, off
.
canmount
The canmount property. Valid values are on
, off
, noauto
.
checksum
The checksum property. Valid values are on
, off
, fletcher2
, fletcher4
, sha256
.
compression
The compression property. Valid values are on
, off
, lzjb
, gzip
, gzip-[1-9]
, zle
.
copies
The copies property. Valid values are 1
, 2
, 3
.
dedup
The dedup property. Valid values are on
, off
.
defaultuserquota
The defaultuserquota property. Valid values are <size>
, none
.
devices
The devices property. Valid values are on
, off
.
ensure
Valid values: present
, absent
The basic property that the resource should be in.
Default value: present
exec
The exec property. Valid values are on
, off
.
logbias
The logbias property. Valid values are latency
, throughput
.
mountpoint
The mountpoint property. Valid values are <path>
, legacy
, none
.
nbmand
The nbmand property. Valid values are on
, off
.
overlay
The overlay property. Valid values are on
, off
.
primarycache
The primarycache property. Valid values are all
, none
, metadata
.
quota
The quota property. Valid values are <size>
, none
.
readonly
The readonly property. Valid values are on
, off
.
recordsize
The recordsize property. Valid values are powers of two between 512 and 128k.
refquota
The refquota property. Valid values are <size>
, none
.
refreservation
The refreservation property. Valid values are <size>
, none
.
relatime
The relatime property. Valid values are on
, off
. Only supported on Linux
reservation
The reservation property. Valid values are <size>
, none
.
secondarycache
The secondarycache property. Valid values are all
, none
, metadata
.
setuid
The setuid property. Valid values are on
, off
.
shareiscsi
The shareiscsi property. Valid values are on
, off
, type=<type>
.
sharenfs
The sharenfs property. Valid values are on
, off
, share(1M) options
sharesmb
The sharesmb property. Valid values are on
, off
, sharemgr(1M) options
snapdir
The snapdir property. Valid values are hidden
, visible
.
sync
The sync property. Valid values are standard
, always
, disabled
.
version
The version property. Valid values are 1
, 2
, 3
, 4
, current
.
volsize
The volsize property. Valid values are <size>
vscan
The vscan property. Valid values are on
, off
.
xattr
The xattr property. Valid values are on
, off
.
zoned
The zoned property. Valid values are on
, off
.
Parameters
The following parameters are available in the zfs
type.
name
namevar
The full name for this filesystem (including the zpool).
provider
The specific backend to use for this zfs
resource. You will seldom need to specify this --- Puppet will usually
discover the appropriate provider for your platform.
zpool
Supports vdevs with mirrors, raidz, logs, spares, and cache.
Examples
Using zpool.
zpool { 'tstpool':
ensure => present,
disk => '/ztstpool/dsk',
}
Properties
The following properties are available in the zpool
type.
ashift
The Alignment Shift for the vdevs in the given pool.
autoexpand
The autoexpand setting for the given pool. Valid values are on
or off
cache
Cache disks for this pool.
disk
The disk(s) for this pool. Can be an array or a space separated string.
ensure
Valid values: present
, absent
The basic property that the resource should be in.
Default value: present
failmode
The failmode setting for the given pool. Valid values are wait
, continue
or panic
log
Log disks for this pool. This type does not currently support mirroring of log disks.
mirror
List of all the devices to mirror for this pool. Each mirror should be a space separated string:
mirror => [\"disk1 disk2\", \"disk3 disk4\"],
raidz
List of all the devices to raid for this pool. Should be an array of space separated strings:
raidz => [\"disk1 disk2\", \"disk3 disk4\"],
spare
Spare disk(s) for this pool.
Parameters
The following parameters are available in the zpool
type.
pool
namevar
The name for this pool.
provider
The specific backend to use for this zpool
resource. You will seldom need to specify this --- Puppet will usually
discover the appropriate provider for your platform.
raid_parity
Determines parity when using the raidz
parameter.
Changelog
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.
v1.6.1 - 2024-07-15
v1.6.0 - 2024-07-15
Added
- Update zfs with relatime support #84 (AriaXLi)
- (PA-5790) Add zfs attribute defaultuserquota #83 (AriaXLi)
- Add support for nvme devices #66 (murkyway)
v1.5.0 - 2024-03-06
v1.4.0 - 2023-02-14
Added
- (PA-4806) Updates PDK template #56 (mhashizume)
v1.3.0 - 2021-10-04
Added
- (MODULES-10874) Add property 'sync' #43 (jameslikeslinux)
1.2.0 - 2020-10-30
Added
Fixed
1.1.0 - 2020-07-09
Added
1.0.5 - 2020-04-01
Fixed
- (MODULES-10592) Fix
zpool status
parsing on Linux #27 (GabrielNagy)
1.0.4 - 2019-11-06
Fixed
- (MODULES-8823) Better handling of ZFS overlay property on Linux #23 (GabrielNagy)
1.0.3 - 2019-11-01
Added
- (MODULES-8823) Add support for overlay option in zfs on Linux #22 (GabrielNagy)
- Use "zpool status -P" instead of "zpool status" #14 (bluthg)
1.0.2 - 2019-02-13
Added
- Add anchors for l10n #10 (joshcooper)
- Expand test coverage #8 (joshcooper)
- (L10n) Delivering translations for POT and README files #7 (ehom)
Fixed
1.0.1 - 2018-08-20
Added
- Install module on all hosts, not just those with default role #4 (joshcooper)
1.0.0 - 2018-05-24
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 [yyyy] [name of copyright owner] 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.
Quality checks
We run a couple of automated scans to help you assess a module’s quality. Each module is given a score based on how well the author has formatted their code and documentation and select modules are also checked for malware using VirusTotal.
Please note, the information below is for guidance only and neither of these methods should be considered an endorsement by Puppet.
Malware scan results
The malware detection service on Puppet Forge is an automated process that identifies known malware in module releases before they’re published. It is not intended to replace your own virus scanning solution.
Learn more about malware scans- Module name:
- puppetlabs-zfs_core
- Module version:
- 1.6.1
- Scan initiated:
- July 15th 2024, 13:01:09
- Detections:
- 0 / 63
- Scan stats:
- 63 undetected
- 0 harmless
- 0 failures
- 0 timeouts
- 0 malicious
- 0 suspicious
- 14 unsupported
- Scan report:
- View the detailed scan report