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-pkgng', '4.1.0'Learn more about managing modules with a PuppetfileDocumentation
Puppet-pkgng
The package provider that matured in this repository has been merged upstream into the core Puppet package providers. As of puppet 4.1, you can enjoy the fruits of the pkgng provider without this module. This module now remains to manage pkg.conf, extra package repositories etc.
If you are looking to build your own PkgNG packages, you may also want to look at the poudriere module.
Upgrading Requirements
To use the 1.x or newer version of this module, ensure that you are running
Puppet 4.1 or higher. Any of the pkgng_* facts that were employed outside of
this repository should be re-evaluated. Those facts are no longer distributed
with this module.
If you are using a Package override to specify that pkgng should be used as the provider, this should no longer be required as the pkgng provider is now the default for FreeBSD.
The latest release of this module to contain the package provider is 0.4.0.
Installation
The easiest way to install is to install from the forge.
puppet module install puppet/pkgng
Then to configure your system to use PkgNG with all default settings, a simple include will do.
include pkgng
You may wish to override settings though, to do this simply use it as a class:
class { 'pkgng':
purge_repos_d => false,
options => [
'PKG_ENV : {',
' http_proxy: "http://proxy:3128"',
'}',
],
}
By default, this module will erase user-defined repository not managed by Puppet.
To disable this behaviour you can use the example above of
setting purge_repos_d to false.
Disabling the FreeBSD default repository is done with:
pkgng::repo { 'FreeBSD':
enabled => false,
}
Using specific repositories is as simple as a Puppet resource.
pkgng::repo { 'pkg.freebsd.org': } # You'll want this one!
pkgng::repo { 'my.own.repo': } # You can then specify more...
Installation via R10K
You can also clone this repo to somewhere in your modulepath, or use something like r10k to deploy your modules. R10k is sweet. For those not familiar, check out Finch's blog post on the subject of module deployment.
To track the git repository, a line in your Puppetfile that looks something like the following should get you started.
mod 'pkgng', :git => 'git://github.com/xaque208/puppet-pkgng.git', :ref => '1.0.0'
Installation via Librarian-Puppet
Installation via Librarian-Puppet is straight forward, simply add the
following to your Puppetfile
mod 'zleslie/pkgng'
Usage
Once the module is installed, you can simply install package resources.
package { 'curl': }
With multiple repositories defined, a package can be installed from a specific repo by giving a URN locator for that repository like this.
pkgng::repo { 'my.own.repo': }
package { 'puppet':
source => 'urn:freebsd:repo:my.own.repo',
}
If you have multiple repos providing the same package you can prefer one repo over the other by increasing the priority. The default priority is 0 and higher priorities are preferred.
pkgng::repo { 'pkg.freebsd.org': }
pkgng::repo { 'my.own.repo':
priority => 10,
}
package {'curl': }
With the above config if the 'curl' package exists in both repositories it would be installed from my.own.repo
Contributing
Please help make this module better. Send pull request, file issues, be mindful of the tests and help improve where you can.
For any provider changes, please submit those directly to core Puppet.
Thanks
Thanks to all contributors who helped mature the provider and helped it graduate from this module into core Puppet. Its maintenance will also require community attention.
Reference
Table of Contents
Classes
pkgng: This configures the PkgNG Package manager on FreeBSD systems, and adds support for managing packages with Puppet. This will eventually be in
Defined types
pkgng::repo: This configures a single PkgNG repository. Instead of defining the repo with the repo URL, we split it up in hostname, mirror_type, protocol
Data types
Pkgng::Mirror_type: The type of a pkg mirrorPkgng::Protocol: The protocol for a pkg mirror
Classes
pkgng
This configures the PkgNG Package manager on FreeBSD systems, and adds support for managing packages with Puppet. This will eventually be in mainline FreeBSD, but for now, we are leaving the installation up to the administrator, since there is no going back.
If you have purge_repos_d as true - then you'll have no repositories defined unless you define one. You want to do this as you'll want this module to control repos anyway.
To install PkgNG, one can simply run the following: make -C /usr/ports/ports-mgmg/pkg install clean
Examples
include pkgng
Parameters
The following parameters are available in the pkgng class:
pkg_dbdir
Data type: Stdlib::Absolutepath
Full path to database directory for pkg(8)
Default value: '/var/db/pkg'
pkg_cachedir
Data type: Stdlib::Absolutepath
Full path to cache directory for pkg(8)
Default value: '/var/cache/pkg'
portsdir
Data type: Stdlib::Absolutepath
Full path to ports directory
Default value: '/usr/ports'
options
Data type: Array[String]
Extra options to write to pkg.conf(5)
Default value: []
purge_repos_d
Data type: Boolean
Whether unmanaged repositories should be removed
Default value: true
repos
Data type: Hash
Repositories to manage using create_resources()
Default value: {}
Defined types
pkgng::repo
This configures a single PkgNG repository. Instead of defining the repo with the repo URL, we split it up in hostname, mirror_type, protocol and repopath. This way, this resource can be integrated with possible firewalls better.
Examples
to use the class
pkg::repo { 'pkg.example.com': }
Parameters
The following parameters are available in the pkgng::repo defined type:
packagehost
Data type: String[1]
Hostname of the repository
Default value: $name
protocol
Data type: Pkgng::Protocol
Transport used to reach the repository
Default value: 'http'
mirror_type
Data type: Pkgng::Mirror_type
Mirror type of the repository
Default value: 'srv'
repopath
Data type: Stdlib::Absolutepath
Path of the repository on packagehost
Default value: '/${ABI}/latest'
enabled
Data type: Boolean
Whether this repository is currently enabled
Default value: true
priority
Data type: Integer[0,100]
Priority of the repository
Default value: 0
pubkey
Data type: Optional[Stdlib::Absolutepath]
Path to the file containing the public key for this repository
Default value: undef
fingerprints
Data type: Optional[Stdlib::Absolutepath]
Path to the file containing known signatures for the repository
Default value: undef
Data types
Pkgng::Mirror_type
The type of a pkg mirror
Alias of Enum['http', 'none', 'srv']
Pkgng::Protocol
The protocol for a pkg mirror
Alias of Enum['file', 'ftp', 'http', 'https', 'ssh']
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.
v4.1.0 (2023-11-06)
Implemented enhancements:
Fixed bugs:
Merged pull requests:
v4.0.0 (2023-07-10)
Breaking changes:
- Drop Puppet 6 support #121 (bastelfreak)
Implemented enhancements:
- Add support for Puppet 8 #124 (smortex)
- Relax dependencies version requirements #123 (smortex)
- Remove legacy
params.pp#119 (smortex)
v3.0.0 (2022-09-13)
Breaking changes:
- Drop support for FreeBSD 11 (EOL) #114 (smortex)
- Drop support for Puppet 5 (EOL) #112 (smortex)
- Drop Puppet 4 support #107 (ekohl)
Implemented enhancements:
Closed issues:
- Allow modifying / disabling repos in /etc #105
Merged pull requests:
- puppet-lint: fix top_scope_facts warnings #109 (bastelfreak)
- Allow stdlib 8.0.0 #108 (smortex)
- Fix reference to which module to install #104 (igalic)
- modulesync 3.0.0 & puppet-lint updates #102 (bastelfreak)
v2.4.0 (2020-05-27)
Merged pull requests:
2.3.0 (2020-01-01)
Merged pull requests:
- Update from xaque208 modulesync_config #96 (zachfi)
- Update from xaque208 modulesync_config #95 (zachfi)
2.2.1 (2019-02-28)
Merged pull requests:
2.2.0 (2019-02-15)
Closed issues:
Merged pull requests:
- Drop old ruby #93 (zachfi)
- facter: always use the repository as a source of package version #92 (olevole)
- Relax dependency on puppetlabs-stdlib #90 (smortex)
- Update repos before installing packages #88 (smortex)
2.1.1 (2018-02-11)
Closed issues:
- Code not in sync with puppet Forge? #84
2.1.0 (2017-07-31)
Summary
This release contains new facts about the state of the package updates and vulnerabilities, nested under 'pkg_*'.
2017-07-29 2.0.0
Summary
This release contains some cleanup in manifest, approach, and testing.
- Recommend adding FreeBSD repo to avoid purging, see README
- Improve testing infrastructure from module_sync to behave like other modules
- Drop old manifest code that was required in early versions of pkgng
2016-10-28 1.2.0
Summary
This release contains updates to testing, and adds support for managing repo signing keys and fingerprints.
2016-05-22 1.1.1
Summary
This release contains updates to testing.
Testing
- Drop guard from Gemfile
2016-05-22 1.1.0
Summary
This release contains an initial changelog as well as default pkg changes.
Features
- Begin changelog
- Include default aliases in pkg.conf(5)
2016-04-04 1.0.0
Summary
This release contains notable changes to the modules functionality.
Noteworthy changes
- Drop support for Puppet3
- Puppet4 support provided by the sysutils/puppet4 port
- Testing and documentation improvements
* This Changelog was automatically generated by github_changelog_generator
Dependencies
- puppetlabs/stdlib (>= 4.6.0 < 10.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
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.