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
- Puppet >= 7.0.0 < 9.0.0
- , ,
Start using this module
Add this module to your Puppetfile:
mod 'puppet-mrepo', '5.0.0'
Learn more about managing modules with a PuppetfileDocumentation
Puppet Mrepo
Transfer Notice
This module creates and synchronizes rpm based repositories by managing mrepo. It is maintained by Vox Pupuli having kindly been migrated from Puppet Inc.
Synopsis
Install and configure a basic mrepo installation
node default {
class { 'mrepo': }
}
Override default values and enable redhat network support for use in other classes
class { 'mrepo':
selinux => true,
rhn => true,
rhn_username => 'user',
rhn_password => 'pass',
}
Or using Hiera for parameters (same example)
code: class { 'mrepo': }
Hiera: mrepo::selinux: true mrepo::rhn: true mrepo::rhn_username: user mrepo::rhn_password: pass
Mirror multiple centos 5 repositories
mrepo::repo { 'centos5-x86_64':
ensure => present,
update => 'nightly',
repotitle => 'CentOS 5.6 64 bit',
arch => 'x86_64',
release => '5.6',
urls => {
addons => 'rsync://mirrors.kernel.org/centos/$release/addons/$arch/',
centosplus => 'rsync://mirrors.kernel.org/centos/$release/centosplus/$arch/',
updates => 'rsync://mirrors.kernel.org/centos/$release/updates/$arch/',
}
}
mrepo::repo { 'centos5-i386':
ensure => present,
update => 'nightly',
repotitle => 'CentOS 5.6 64 bit',
arch => 'i386',
release => '5.6',
urls => {
addons => 'rsync://mirrors.kernel.org/centos/$release/addons/$arch/',
centosplus => 'rsync://mirrors.kernel.org/centos/$release/centosplus/$arch/',
updates => 'rsync://mirrors.kernel.org/centos/$release/updates/$arch/',
}
}
Mirror multiple rhel channels
mrepo::repo { 'rhel6server-x86_64':
ensure => present,
update => 'nightly',
repotitle => 'Red Hat Enterprise Linux Server $release ($arch)',
rhn => true,
type => 'rhn',
arch => 'x86_64',
release => '6',
typerelease => '6Server',
iso => 'rhel-server-6.0-$arch-dvd.iso',
urls => {
updates => 'rhns:///rhel-$arch-server-$release',
vt => 'rhns:///rhel-$arch-server-vt-$release',
supplementary => 'rhns:///rhel-$arch-server-supplementary-$release',
fasttrack => 'rhns:///rhel-$arch-server-fasttrack-$release',
hts => 'rhns:///rhel-$arch-server-hts-$release',
rhn-tools => 'rhns:///rhn-tools-rhel-$arch-server-$release',
}
}
Fetch and place an ISO file for the above rhel6server-x86_64 repo
mrepo::iso { 'rhel-server-6.0-$arch-dvd.iso':
source_url => 'http://some.domain.tld/path/to/isodir',
repo => 'rhel6server-x86_64',
}
Usage
If you need to customize the mrepo default settings, include the mrepo class and include the appropriate variables. Else, you should be able to use the mrepo::repo by itself to instantiate repositories.
For class/define specific documentation, view the puppet doc in the given file.
Prerequisites
This module expects the following modules to be available:
- puppetlabs-apache
- puppetlabs-stdlib
- puppetlabs-vcsrepo
It also is configured for a redhat derived system and makes assumptions about the available users and groups. Alternate parameters may override these assumptions.
Mirror data can grow extremely large, so you will want to ensure that src_root is located on a large volume.
If you are planning on using ISOs, you will also need fuse-iso.
Repository URL formatting
You can take advantage of the variables that mrepo itself supports when defining a repository or ISO to mirror. Mrepo uses the following variables:
- $dist is set to the title of the resource
- $arch is set to the arch parameter
- $nick is set to $dist-$arch
- $repo is set to the key of the specific repository
- $release is set to the release parameter
Note that these are variables within mrepo; if you are using them, make sure to surround the string in single quotes so puppet doesn't try to expand them.
So this:
mrepo::repo { 'centos5-x86_64':
ensure => present,
update => 'nightly',
repotitle => 'CentOS 5.6 64 bit',
arch => 'x86_64',
release => '5.6',
urls => {
addons => 'rsync://mirrors.kernel.org/centos/$release/$repo/$arch/',
centosplus => 'rsync://mirrors.kernel.org/centos/$release/$repo/$arch/',
updates => 'rsync://mirrors.kernel.org/centos/$release/$repo/$arch/',
}
}
Is equivalent to this:
mrepo::repo { 'centos5-x86_64':
ensure => present,
update => 'nightly',
repotitle => 'CentOS 5.6 64 bit',
arch => 'x86_64',
release => '5.6',
urls => {
addons => 'rsync://mirrors.kernel.org/centos/5.6/addons/x86_64/',
centosplus => 'rsync://mirrors.kernel.org/centos/5.6/centosplus/x86_64/',
updates => 'rsync://mirrors.kernel.org/centos/5.6/updates/x86_64/',
}
}
Be warned that you can make a repository with the name of 'release'; however, this will overwrite the actual release variable. If you have a repository with a name of release, change the key to something else, and explicitly define the url instead of using a variable.
For full details on how mrepo is used, see the mrepo usage page.
Caveats
Params Pattern
This module was previously using a design where the params class was used as the main class and included in other classes.
It now follows the params pattern, where parameters are set in the params class as default, inherited, then overwritten as needed when calling the base class.
Before:
Using classes
class { 'mrepo::params':
selinux => true,
rhn => true,
rhn_username => 'user',
rhn_password => 'pass',
}
After:
class { 'mrepo':
selinux => true,
rhn => true,
rhn_username => 'user',
rhn_password => 'pass',
}
SELinux
Default SELinux policy prevents the httpd context from manipulating loopback devices without having an explicit httpd context. This can be corrected by changing the context as a mount option for a regular mount. However, fuseiso does not have the capability to change selinux contexts. If you are planning on mounting ISOs, either do so as root, change the httpd context to permit fuseiso to run using audit2allow, or disable SELinux. If neither of these are viable options, you can locate and mirror an outside repository of the ISO data.
Further clarification of this issue can be found on the repoforge tools list.
Fuse ISO
Fuse iso is not available in any yum repository. You will need to locate an RPM or source file and install it for yourself. In addition, if you are using a non-root user to mount the ISOs, you will need to ensure that the user is in the 'fuse' group.
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.0 (2024-08-19)
Breaking changes:
- Drop EoL Scientific Linux #142 (bastelfreak)
- Drop Eol EL6 #140 (bastelfreak)
- Drop Puppet 6 support #127 (bastelfreak)
Implemented enhancements:
- Add EL9 support #141 (bastelfreak)
- puppet/apache: Allow 12.x #134 (zilchms)
- puppetlabs/vcsrepo: Allow 6.x #133 (zilchms)
- puppet/archive: Allow 7.x #132 (zilchms)
- Add Puppet 8 support #129 (bastelfreak)
- puppetlabs/stdlib: Allow 9.x #128 (bastelfreak)
- puppet/archive: allow 5.x #123 (bastelfreak)
Fixed bugs:
- Fix use of
selinux
fact #112 (alexjfisher) - Fix datatype of attribute metadata #111 (mrolli)
Merged pull requests:
- Remove legacy top-scope syntax #130 (smortex)
- Allow stdlib 8.0.0 #124 (smortex)
- modulesync 3.0.0 & puppet-lint updates #116 (bastelfreak)
- delete legacy travis directory #113 (bastelfreak)
v4.1.0 (2019-11-18)
Implemented enhancements:
Fixed bugs:
Merged pull requests:
- allow puppetlabs/vcsrepo 3.x #108 (bastelfreak)
- Allow
puppetlabs/apache
5.x,puppetlabs/stdlib
6.x andpuppet/archive
4.x #105 (alexjfisher) - Allow puppetlabs/apache 4.x #104 (mrolli)
v4.0.0 (2019-05-02)
Breaking changes:
- modulesync 2.5.1 and drop Puppet 4 #100 (bastelfreak)
- Manage iso directory within mrepo::iso (requires puppet/archive, drop puppet/staging) #97 (mrolli)
Merged pull requests:
- modulesync 2.2.0 and allow puppet 6.x #96 (bastelfreak)
v3.1.1 (2018-09-07)
Merged pull requests:
- allow puppetlabs/stdlib 5.x #93 (bastelfreak)
- allow puppet/staging 3.x & puppetlabs/apache 3.x #91 (bastelfreak)
- Remove docker nodesets #87 (bastelfreak)
- bump puppet to latest supported version 4.10.0 #83 (bastelfreak)
v3.1.0 (2017-11-27)
Merged pull requests:
- Update metadata dependencies for puppet5 support #78 (alexjfisher)
v3.0.0 (2017-10-11)
Breaking changes:
- BREAKING: Drop puppet 3 support. Replace validate_* with datatypes #75 (bastelfreak)
Closed issues:
- Module will not install #72
Merged pull requests:
- Fix github license detection #73 (alexjfisher)
- enable mrepo service by default #68 (PascalBourdier)
- Refactors UUID exec to use fqdn_uuid function #60 (petems)
v2.1.0 (2017-01-13)
Closed issues:
- selinux context incorrect for centos 7.2.1151 #51
- Major version bump to remove older parameters #43
- Refactor to use param pattern #42
Merged pull requests:
- modulesync 0.16.7 #64 (bastelfreak)
- Set min version_requirement for Puppet + deps #63 (juniorsysadmin)
- modulesync 0.16.6 #62 (bastelfreak)
- modulesync 0.16.4 #61 (bastelfreak)
- Refactor to use the params pattern #56 (petems)
- modulesync 0.16.3 #55 (bastelfreak)
- modulesync 0.15.0 #54 (bastelfreak)
- Update based on voxpupuli/modulesync_config 0.14.1 #53 (dhoppe)
- Parameterized the selinux context: https://github.com/voxpupuli/puppe… #52 (mlosapio)
- modulesync 0.13.0 #50 (bbriggs)
- Modulesync 0.12.7 #49 (alexjfisher)
- Fix Puppetforge badge #48 (alexjfisher)
v2.0.1 (2016-09-16)
Merged pull requests:
- Release 2.0.1 #47 (alexjfisher)
- Add travis secret #46 (alexjfisher)
v2.0.0 (2016-09-16)
Closed issues:
- master not working since last commit #13
Merged pull requests:
- Release 2.0.0 #45 (alexjfisher)
- Add new
rhnget
options #44 (alexjfisher) - Add the most basic of rspec-puppet tests #41 (alexjfisher)
- Modulesync #39 (alexjfisher)
- Update README and metadata.json after VP migration #38 (alexjfisher)
- Add
mailfrom
andsmtpserver
parameters #37 (ghost)
1.2.1 (2016-04-26)
Merged pull requests:
- Prep for 1.2.1 release #32 (HelenCampbell)
- Shorten summary #31 (petems)
- (maint) module does not unmount ISOs #30 (shermdog)
- (MODULES-2950) Remove non-root user cron jobs #29 (shermdog)
1.2.0 (2015-08-12)
Merged pull requests:
- Release 1.2.0 #27 (hunner)
- only include the
ip
parameter in the apache vhost if $ip_based is true #26 (ghost) - Explicitly scope $mrepo::params::use_selinux #25 (smarlow)
- Fix syntax error #24 (arioch)
- Add ip-based vhost #23 (arioch)
- fix smart quote #22 (underscorgan)
- Add metadata summary in Modulefile per FM-1523 #20 (lrnrthr)
- RedHat Network fixes and documentation #18 (esalberg)
- fix repo variable; 'name' was confused. #17 (easescript)
- No guarantee that 'mrepo::repos' will be included #15 (hakamadare)
- Enable specifying port and priority for vhost #14 (hakamadare)
- Mrepo cmd params #12 (zipkid)
- Mrepo reorg 06 #11 (zipkid)
- Fix two minor items which make module unusable by default #8 (rhysrhaven)
1.1.1 (2013-05-09)
1.1.0 (2012-10-03)
Merged pull requests:
- Release of 1.1.0 #7 (adrienthebo)
1.0.0 (2012-08-28)
v0.1.3 (2012-02-12)
Merged pull requests:
- Update Modulefile dependency information #4 (adrienthebo)
v0.1.2 (2011-12-14)
v0.1.1 (2011-09-16)
Merged pull requests:
v0.1.0 (2011-09-16)
Merged pull requests:
- First release of mrepo #2 (adrienthebo)
0.1.0 (2011-09-15)
* This Changelog was automatically generated by github_changelog_generator
Dependencies
- puppetlabs/apache (>= 2.0.0 < 13.0.0)
- puppetlabs/vcsrepo (>= 1.3.1 < 7.0.0)
- puppetlabs/stdlib (>= 4.19.0 < 10.0.0)
- puppet/archive (>= 3.2.1 < 8.0.0)
Copyright 2011 Puppet Labs 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