yumrepo_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
- Puppet >= 7.0.0 < 9.0.0
- CentOS, OracleLinux, RedHat, Scientific, Fedora, Rocky, AlmaLinux, Amazon
Start using this module
Add this module to your Puppetfile:
mod 'puppetlabs-yumrepo_core', '2.1.0'
Learn more about managing modules with a PuppetfileDocumentation
yumrepo_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
- Development - Guide for contributing to the module
Description
The yumrepo_core module is used to manage client yum repo configurations by parsing INI configuration files.
Usage
To manage a yum repo for Puppet Labs Products while using a local mirror, use the following code:
yumrepo { 'puppetrepo-products':
ensure => 'present',
name => 'puppetrepo-products',
descr => 'Puppet Labs Products El 7 - $basearch',
baseurl => 'http://myownmirror',
gpgkey => 'http://myownmirror',
enabled => '1',
gpgcheck => '1',
target => '/etc/yum.repo.d/puppetlabs.repo',
}
Reference
Please see REFERENCE.md for the reference documentation.
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.
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
yumrepo
: The client-side description of a yum repository.
Resource types
yumrepo
Repository configurations are found by parsing /etc/yum.conf
and the files
indicated by the reposdir
option in that file (see yum.conf(5)
for
details).
Most parameters are identical to the ones documented
in the yum.conf(5)
man page.
Continuation lines that yum supports (for the baseurl
, for example)
are not supported. This type does not attempt to read or verify the
existence of files listed in the include
attribute."
Properties
The following properties are available in the yumrepo
type.
assumeyes
Valid values: YUM_BOOLEAN
, absent
Determines if yum prompts for confirmation of critical actions.
bandwidth
Valid values: %r{^\d+[kMG]?$}
, absent
Use to specify the maximum available network bandwidth
in bytes/second. Used with the throttle
option. If throttle
is a percentage and bandwidth
is 0
then bandwidth throttling
will be disabled. If throttle
is expressed as a data rate then
this option is ignored.\n
baseurl
Valid values: %r{.*}
, absent
The URL for this repository.
cost
Valid values: %r{^\d+$}
, absent
Cost of this repository.
deltarpm_metadata_percentage
Valid values: %r{^\d+$}
, absent
Percentage value that determines when to download deltarpm metadata. When the deltarpm metadata is larger than this percentage value of the package, deltarpm metadata is not downloaded.
deltarpm_percentage
Valid values: %r{^\d+$}
, absent
Percentage value that determines when to use deltas for this repository. When the delta is larger than this percentage value of the package, the delta is not used.
descr
Valid values: %r{.*}
, absent
A human-readable description of the repository.
This corresponds to the name parameter in yum.conf(5)
.
enabled
Valid values: YUM_BOOLEAN
, absent
Whether this repository is enabled.
enablegroups
Valid values: YUM_BOOLEAN
, absent
Whether yum will allow the use of package groups for this repository.
ensure
Valid values: present
, absent
The basic property that the resource should be in.
Default value: present
exclude
Valid values: %r{.*}
, absent
The string of package names or shell globs separated by spaces to exclude. Packages that match the package name given or shell globs will never be considered in updates or installs for this repo.
failovermethod
Valid values: %r{^roundrobin|priority$}
, absent
The failover method for this repository; should be either
roundrobin
or priority
.
gpgcakey
Valid values: %r{.*}
, absent
The URL for the GPG CA key for this repository.
gpgcheck
Valid values: YUM_BOOLEAN
, absent
Whether to check the GPG signature on packages installed from this repository.
gpgkey
Valid values: %r{.*}
, absent
The URL for the GPG key with which packages from this repository are signed.
http_caching
Valid values: %r{^(packages|all|none)$}
, absent
What to cache from this repository.
include
Valid values: %r{.*}
, absent
The URL of a remote file containing additional yum configuration settings. Puppet does not check for this file's existence or validity.
includepkgs
Valid values: %r{.*}
, absent
The string of package names or shell globs separated by spaces to include. If this is set, only packages matching one of the package names or shell globs will be considered for update or install from this repository.
keepalive
Valid values: YUM_BOOLEAN
, absent
Whether HTTP/1.1 keepalive should be used with this repository.
metadata_expire
Valid values: %r{^([0-9]+[dhm]?|never)$}
, absent
Number of seconds after which the metadata will expire.
metalink
Valid values: %r{.*}
, absent
Metalink for mirrors.
minrate
Valid values: %r{^\d+$}
, absent
Sets the low speed threshold in bytes per second.
If the server is sending data slower than this for at least
timeout
seconds, Yum aborts the connection. The default is
1000
.
mirrorlist
Valid values: %r{.*}
, absent
The URL that holds the list of mirrors for this repository.
mirrorlist_expire
Valid values: %r{^[0-9]+$}
, absent
Time (in seconds) after which the mirrorlist locally cached will expire.\n
module_hotfixes
Valid values: YUM_BOOLEAN
, absent
Whether packages from this repo can be installed into modules.
password
Valid values: %r{.*}
, absent
Password to use with the username for basic authentication.
payload_gpgcheck
Valid values: YUM_BOOLEAN
, absent
Whether to check the GPG signature of the packages payload.
priority
Valid values: %r{^-?\d+$}
, absent
Priority of this repository. Can be any integer value
(including negative). Requires that the priorities
plugin
is installed and enabled.
protect
Valid values: YUM_BOOLEAN
, absent
Enable or disable protection for this repository. Requires
that the protectbase
plugin is installed and enabled.
proxy
Valid values: %r{.*}
, absent
URL of a proxy server that Yum should use when accessing this repository. This attribute can also be set to 'none' (or '' for EL >= 8 only), which will make Yum bypass any global proxy settings when accessing this repository.
proxy_password
Valid values: %r{.*}
, absent
Password for this proxy.
proxy_username
Valid values: %r{.*}
, absent
Username for this proxy.
repo_gpgcheck
Valid values: YUM_BOOLEAN
, absent
Whether to check the GPG signature on repodata.
retries
Valid values: %r{^[0-9]+$}
, absent
Set the number of times any attempt to retrieve a file should
retry before returning an error. Setting this to 0
makes yum
try forever.\n
s3_enabled
Valid values: YUM_BOOLEAN
, absent
Access the repository via S3.
skip_if_unavailable
Valid values: YUM_BOOLEAN
, absent
Should yum skip this repository if unable to reach it.
sslcacert
Valid values: %r{.*}
, absent
Path to the directory containing the databases of the certificate authorities yum should use to verify SSL certificates.
sslclientcert
Valid values: %r{.*}
, absent
Path to the SSL client certificate yum should use to connect to repositories/remote sites.
sslclientkey
Valid values: %r{.*}
, absent
Path to the SSL client key yum should use to connect to repositories/remote sites.
sslverify
Valid values: YUM_BOOLEAN
, absent
Should yum verify SSL certificates/hosts at all.
throttle
Valid values: %r{^\d+[kMG%]?$}
, absent
Enable bandwidth throttling for downloads. This option
can be expressed as a absolute data rate in bytes/sec or a
percentage 60%
. An SI prefix (k, M or G) may be appended
to the data rate values.\n
timeout
Valid values: %r{^\d+$}
, absent
Number of seconds to wait for a connection before timing out.
username
Valid values: %r{.*}
, absent
Username to use for basic authentication to a repo or really any url.
Parameters
The following parameters are available in the yumrepo
type.
name
namevar
The name of the repository. This corresponds to the
repositoryid
parameter in yum.conf(5)
.
provider
The specific backend to use for this yumrepo
resource. You will seldom need to specify this --- Puppet will usually
discover the appropriate provider for your platform.
target
The filepath of the local repository file, can be either relative or absolute. If a valid filepath is not specified, the
target is created as a new section in yum.conf(5)
Default value: absent
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.
v2.1.0 - 2024-03-06
Added
- (PA-5575) Add Amazon to display support in Puppet forge #65 (shubhamshinde360)
v2.0.0 - 2023-06-07
Changed
- (maint) Drop Puppet 6 and PDK Update #55 (mhashizume)
Added
- (PA-5187) Add target support #54 (mhashizume)
v1.2.0 - 2023-02-14
Added
- (MODULES-11371) Updates PDK template #49 (mhashizume)
v1.1.0 - 2021-10-04
Added
- (MODULES-11167)(MODULES-11191) Add RockyLinux && AlmaLinux to yumrepo_core metadata #39 (BobosilaVictor)
1.0.7 - 2020-04-13
Added
1.0.6 - 2019-12-19
Fixed
- (MODULES-10357) Fix
proxy => absent
#24 (alexjfisher)
1.0.5 - 2019-12-18
Fixed
- (MODULES-10246) Proxy settings allow empty string #22 (Dorin-Pleava)
1.0.4 - 2019-11-01
Added
1.0.3 - 2019-01-11
Added
1.0.2 - 2018-11-29
Added
Fixed
1.0.1 - 2018-08-17
1.0.0 - 2018-07-09
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-yumrepo_core
- Module version:
- 2.1.0
- Scan initiated:
- March 6th 2024, 15:03:01
- Detections:
- 0 / 59
- Scan stats:
- 59 undetected
- 0 harmless
- 0 failures
- 0 timeouts
- 0 malicious
- 0 suspicious
- 16 unsupported
- Scan report:
- View the detailed scan report