Version information
This version is compatible with:
- Puppet Enterprise 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-cpanm', '1.0.0'Learn more about managing modules with a PuppetfileDocumentation
cpanm
Table of Contents
- Description
- Setup - The basics of getting started with cpanm
- Usage - Configuration options and additional functionality
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Description
The cpanm module manages CPAN packages using the cpanminus package. It exists to provide a simple way to install CPAN modules with the option to not run test suites. The intent is that it should work with Debianish and Redhatty distributions.
The module provides a class cpanm which will install Perl components, gcc,
make and cpanminus itself. It also provides a resource type cpanm which you
can use to manage modules in more or less the same way as package works.
Setup
What cpanm affects
This module will install the following packages unless manage_dependencies is set to false:
- perl
- gcc
- make
- perl-core on RHEL7
It will also install cpanm itself in a standard directory, generally
/usr/bin or /usr/local/bin.
Setup Requirements
This module uses curl to download the cpanminus installer.
Beginning with cpanm
include cpanm
cpanm {'CGI':
ensure => latest,
}
Usage
Both the cpanm class and resource support a mirror parameter to control
which CPAN archive packages are fetched from. The cpanm resource supports
additional parameters, test and force, to enable CPAN tests and force CPAN
installation respectively.
Limitations
The listing of installed CPAN modules is based on perldoc perllocal. This
generally works well, but doesn't get updated when you remove a CPAN module.
Development
This module is maintained by Vox Pupuli. Vox Pupuli welcomes new contributions to this module, especially those that include documentation and rspec tests. We are happy to provide guidance if necessary.
Please see CONTRIBUTING for more details.
Please log tickets and issues on github.
Transfer Notice
This module was originally authored by James McDonald james@jamesmcdonald.com. The maintainer preferred that Puppet Community take ownership of the module for future improvement and maintenance. Existing pull requests and issues were transferred over, please fork and continue to contribute here instead.
Previously: https://github.com/jamesmcdonald/puppet-cpanm
Reference
Table of Contents
Classes
cpanm: Downloads and installs cpanminus.
Resource types
cpanm: Manage CPAN modules with cpanminus
Data types
Cpanm::HTTPUrl: Validate a HTTP(S) URL
Classes
cpanm
Downloads and installs cpanminus.
Examples
include cpanm
class {'cpanm':
mirror => 'http://mirror.my.org/cpan/',
}
Parameters
The following parameters are available in the cpanm class:
installer
Data type: Cpanm::HTTPUrl
Url to the cpanm installer.
Default value: 'https://cpanmin.us'
manage_dependencies
Data type: Boolean
Wether this module should manage the following dependencies
- purl
- purl-core (rhel7)
- make
- gcc
Default value: true
mirror
Data type: Optional[Cpanm::HTTPUrl]
A CPAN mirror to use to retrieve App::cpanminus. This is passed to
cpanm as --from, meaning that only this mirror will be used.
Default value: undef
lwpbootstraparg
Data type: Boolean
cpanminus bootstrap arguments
Default value: false
Resource types
cpanm
Manage CPAN modules with cpanminus
Properties
The following properties are available in the cpanm type.
ensure
Valid values: absent, present, installed, latest
Aliases: "installed"=>"present"
The basic property that the resource should be in.
Default value: installed
Parameters
The following parameters are available in the cpanm type.
force
Force installation
Default value: false
mirror
URL of the CPAN mirror to use
name
namevar
The CPAN module to manage
provider
The specific backend to use for this cpanm resource. You will seldom need to specify this --- Puppet will usually
discover the appropriate provider for your platform.
test
Run CPAN module tests
Default value: false
Data types
Cpanm::HTTPUrl
Validate a HTTP(S) URL
Alias of Pattern[/(?i:\Ahttps?:\/\/.*\z)/]
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.
v1.0.0 (2024-03-06)
Breaking changes:
Merged pull requests:
v0.9.17 (2023-06-01)
Changed
- Merged PR#15 from jfoche to support stdlib <9
v0.9.16 (2023-04-02)
Changed
- Merged PR#14 (fixing #13) to fix checks for
@version.
v0.9.15 (2023-03-21)
Changed
- Merged PR#10 from jovandeginst to allow stdlib versions <8.
v0.9.13 (2022-04-20)
Changed
- Fixed #11 from gremble regarding modules where detection of an
installed version failed. Use
Module::Metadatato get this information more reliably.
v0.9.12 (2021-10-13)
Changed
- Merged PR#10 from xiconfjs to allow
@versionin module names.
v0.9.11 (2021-07-16)
Changed
- Merged PR#8 from martindemello to correctly check :force in Puppet 5.5.
v0.9.10 (2020-06-14)
Changed
- Merged PR#7 from arpagon to change the top version limit for stdlib to <7.0.0 allowing the use of newer versions.
- Updated test fixtures to use stdlib 6.3.0.
v0.9.9 (2018-09-06)
Added
- Merged PR#5 from treyormsbee to add lwpbootstrap option which allows
the bootstrap to be run with
--no-lwp.
v0.9.8 (2018-05-26)
Added
- Added this changelog.
- Updated bundled
cpanmto 1.7044.
v0.9.6 (2018-05-26)
Changed
- Fixed issue #3 where Perl modules that cannot be imported were reinstalled on every puppet run.
v0.9.5 (2018-05-25)
Added
- Merged a PR from @dutsmiller using
ensure_packagesrather thanpackageresources to avoid conflicts.
Changed
- Fixed an issue where modules with non-ASCII characters in their metadata
triggered a bug in old versions of
Encodewith incorrect locale settings. - Added a dependency on stdlib for the
ensure_packagesfunction. - Added Debian 9.0 to the supported OS list.
v0.9.4 (2017-03-27)
Added
- Support for specifying a CPAN mirror with the
mirrorparameter. - Tests for both supported platforms, Debian and Red Hat.
Changed
- Fix examples to be compatible with Puppet 3.
- Clean up perllocal parsing.
- Update documentation.
v0.9.3 (2016-12-21)
Changed
- Add OS support to module metadata.
v0.9.2 (2016-12-21)
Removed
- Dependency on stdlib, which is not in use.
v0.9.1 (2016-12-21)
Removed
- Debug output.
v0.9.0 (2016-12-21)
Added
- Tests for the puppet code.
- Example manifests to test install, latest and remove.
Changed
- Support cpanm being installed in
/usr/local/bin. - Add
perl-corepackage on RHEL 6+. - Fix various errors.
- Update README.
- Change licence to Perl to be compatible with cpanminus itself.
v0.1.0 (2016-12-10)
Added
- Initial code.
- Bundled a copy of cpanminus for bootstrapping.
* This Changelog was automatically generated by github_changelog_generator
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.