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
- Puppet >= 6.1.0 < 8.0.0
Start using this module
Add this module to your Puppetfile:
mod 'puppet-jail', '5.0.1'Learn more about managing modules with a PuppetfileDocumentation
FreeBSD Jail management with Puppet
Manage FreeBSD jails with Puppet, leveraging iocage for jail management.
Setup
This module expects to be the only jail manager on a given system. Each system where jails will be managed needs to include the jail::setup class as well.
include jail::setup
This simply installs 'iocage' and removes '/etc/jail.conf'.
This allows the type to use the correct jail without having to specify the pool on each jail.
A simple jail
jail { 'myjail1':
ensure => present,
state => 'up',
ip4_addr => 'em0|10.0.0.10/24',
ip6_addr => 'em0|fc00::10/64',
hostname => 'myjail1.example.com',
boot => 'on',
user_data => template('mysite/user_data.sh.erb'),
}
Note the ip4_addr and the ip6_addr properties take an interface name and an IP address separated by a pipe character. This value is passed directly to iocage(7). You may wish to read the man page.
Reference
Table of Contents
Classes
jail::setup: Lay down the global configuration for jail.conf as well as create the needed directories and/or zfs mountpoints.
Resource types
jail: The jail ID for running jails This is a read-only property.jail_release: The release to fetch
Classes
jail::setup
Lay down the global configuration for jail.conf as well as create the needed directories and/or zfs mountpoints.
Parameters
The following parameters are available in the jail::setup class:
package_name
Data type: String[1]
name of the package that provides iocage
Default value: 'py36-iocage'
Resource types
jail
The jail ID for running jails
This is a read-only property.
Properties
The following properties are available in the jail type.
boot
Valid values: on, off
Either on or off
ensure
Valid values: present, absent
The basic property that the resource should be in.
Default value: present
fstab
A list of fstab entries for this jail to be mounted into. By default these are nullfs mounts.
ip4_addr
Interface|Address[,Interface|Address[...]]
Changes to this property will cause a restart of the jail.
ip6_addr
Interface|Address[,Interface|Address[...]]
Changes to this property will cause a restart of the jail.
jail_zfs
Valid values: on, off
Enable the jail_zfs
jid
The jail ID for running jails
This is a read-only property.
memoryuse
Cap the RAM usage of a jail
pcpu
Cap the CPU usage of a jail
properties
All properties (that deviate from the default)
quota
Set maximum disk usage for a jail
release
FreeBSD release of this jail. EMPTY if this is a Linux jail. release and template are mutually exclusive.
Changes to this property will lead to destruction and rebuild of the jail.
rlimits
Valid values: on, off
Enable|Disable Limits
state
Valid values: up, down
Either running or stopped
template
Template jail to base this one off. release and template are mutually exclusive.
Changes to this property will lead to destruction and rebuild of the jail.
type
Valid values: jail, basejail, template
Type of jail. This can be jail, basejail, or template
Changes to this property will lead to destruction and rebuild of the jail.
Default value: jail
Parameters
The following parameters are available in the jail type.
allow_rebuild
Valid values: true, false
Allow destroying! and rebuilding of this jail
Default value: true
allow_restart
Valid values: true, false
Allow restarting of this jail
Default value: true
name
Valid values: %r{^[a-zA-Z0-9_-]+$}
namevar
The name (and hostname) of the jail
pkglist
A list of packages to be installed in this jail before startup
provider
The specific backend to use for this jail resource. You will seldom need to specify this --- Puppet will usually
discover the appropriate provider for your platform.
user_data
Rendered content to pipe to a jailed shell upon creation
Changes to this property will lead to destruction and rebuild of the jail.
jail_release
The release to fetch
Properties
The following properties are available in the jail_release type.
ensure
Valid values: present, absent
The basic property that the resource should be in.
Default value: present
Parameters
The following parameters are available in the jail_release type.
name
namevar
The release to fetch
provider
The specific backend to use for this jail_release resource. You will seldom need to specify this --- Puppet will
usually discover the appropriate provider for your platform.
Changelog
All notable changes to this project will be documented in this file. Each new release typically also includes the latest modulesync defaults. These should not affect the functionality of the module.
v5.0.1 (2022-03-11)
Breaking changes:
Merged pull requests:
- puppetlabs/concat: Fix version range in metadata.json #65 (bastelfreak)
- cleanup old hiera-in-modules setup #64 (bastelfreak)
- modulesync 5.2.0 / package_name: Add
String[1]datatype #63 (bastelfreak)
v5.0.0 (2021-06-15)
Breaking changes:
- Drop EoL Puppet 5 support; Add Puppet 7 #57 (bastelfreak)
Implemented enhancements:
- Add FreeBSD 11-13 support #54 (bastelfreak)
Merged pull requests:
- puppetlabs/concat: Allow latest releases #58 (bastelfreak)
- cleanup metadata.json + README.md / add missing LICENSE file #55 (bastelfreak)
- Drop Puppet 4, add Puppet 5 and 6 #53 (ekohl)
- modulesync 3.0.0 & puppet-lint updates #50 (bastelfreak)
- Set the property only if required #47 (xaque208)
- Update from xaque208 modulesync_config #46 (xaque208)
4.0.1 (2019-03-26)
Summary
A significant update to the module. Please see the readme for change details.
- Modulesync for deployment updates
- Add design doc for where to keep the conversation about approach
- Replace iocage.sh provider with iocage.py provider
- Moved iocage.sh provider to iocage_legacy name
- Add new properties
2016-08-29 3.1.0
Summary
Drop old puppet versions, add tests for existing functionality.
2016-07-27 3.0.0
Summary
Drop legacy code and add new zfs properties.
Features
- Add ZFS properties
- Drop legacy jail provider
2016-05-31 2.1.1
Summary
Changes to testing dependencies.
Testing
- Drop guard from the Gemfile
A feature release.
2016-05-31 2.1.0
Summary
A feature release.
Features
- Add user_data support for first boot script
2016-04-25 2.0.9
Summary
This release adds a changelog.
Features
- Add a changelog
2016-04-22 2.0.8
Summary
This is a bugfix release.
Bugfixes
- Handl the order of the iocage service and package correctly
2016-04-04 2.0.7
Summary
This is a testing release.
Testing
- Update tests to include puppet4
2016-03-08 2.0.6
Summary
This is a bugfix release to avoid starting the iocage service.
Bugfixes
- Only enable the service as there is no daemon
2016-03-08 2.0.5
Summary
This is a feature release to include iocage service management.
Features
- Manage the iocage service
2016-02-21 2.0.4
Summary
This is a bugfix release.
Bugfixes
- Fix regex match more complex hostnames and add test
2015-11-28 2.0.3
Summary
This is a bugfix release to address property handling.
Bugfixes
- Set jail properties upon creation before boot
2015-10-19 2.0.2
Summary
This is a bugfix release.
Bugfixes
- Fix regex to include JIDs that begin with '1' and add test
2015-09-08 2.0.1
Summary
This is a bugfix release.
Bugfixes
- Add regex matching for discovering only iocage created jails
- Fix boot parameter in documentation
2015-08-16 2.0.0
Summary
This is a backwards incompatible release to support a new jail management utility framework called iocage(8).
Features
- Add new provider for iocage with basic tests
- Adjust type parameters to match iocage nomenclature
2015-08-16 1.0.0
Summary
This release is the first major release of the jail module, containing a minimal pattern of creating ZFS based jails using a puppet type and provider.
Features
- Initial type and provider for managing ZFS based jails
* This Changelog was automatically generated by github_changelog_generator
Dependencies
- puppetlabs/concat (>= 1.1.0 < 8.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 {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.