annotate modules/epel/README.md @ 387:66c075c5f54a

Update to newer Python module
author IBBoard <dev@ibboard.co.uk>
date Mon, 03 Jan 2022 17:13:06 +0000
parents c42fb28cff86
children adf6fe9bbc17
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1 # Configure EPEL (Extra Repository for Enterprise Linux)
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
2
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
3 [![Build Status](https://github.com/voxpupuli/puppet-epel/workflows/CI/badge.svg)](https://github.com/voxpupuli/puppet-epel/actions?query=workflow%3ACI)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
4 [![Release](https://github.com/voxpupuli/puppet-epel/actions/workflows/release.yml/badge.svg)](https://github.com/voxpupuli/puppet-epel/actions/workflows/release.yml)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
5 [![Puppet Forge](https://img.shields.io/puppetforge/v/puppet/epel.svg)](https://forge.puppetlabs.com/puppet/epel)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
6 [![Puppet Forge - downloads](https://img.shields.io/puppetforge/dt/puppet/epel.svg)](https://forge.puppetlabs.com/puppet/epel)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
7 [![Puppet Forge - endorsement](https://img.shields.io/puppetforge/e/puppet/epel.svg)](https://forge.puppetlabs.com/puppet/epel)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
8 [![Puppet Forge - scores](https://img.shields.io/puppetforge/f/puppet/epel.svg)](https://forge.puppetlabs.com/puppet/epel)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
9 [![puppetmodule.info docs](http://www.puppetmodule.info/images/badge.png)](http://www.puppetmodule.info/m/puppet-epel)
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
10 [![AGPL v3 License](https://img.shields.io/github/license/voxpupuli/puppet-epel.svg)](LICENSE)
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
11
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
12 # About
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
13 This module basically just mimics the epel-release rpm. The same repos are
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
14 enabled/disabled and the GPG key is imported. In the end you will end up with
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
15 the EPEL repos configured.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
16
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
17 The following Repos will be setup and enabled by default:
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
18
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
19 * epel
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
20
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
21 Other repositories that will setup but disabled (as per the epel-release setup)
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
22
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
23 * epel-debuginfo
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
24 * epel-source
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
25 * epel-testing
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
26 * epel-testing-debuginfo
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
27 * epel-testing-source
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
28
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
29 # Usage
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
30
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
31 In nearly all cases, you can simply _include epel_ or classify your nodes with
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
32 the epel class. There are quite a few parameters available if you need to modify
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
33 the default settings for the epel repository such as having your own mirror, an
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
34 http proxy, or disable gpg checking.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
35
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
36 A list of all parameters is available in [REFERENCE.md](REFERENCE.md).
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
37
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
38 You can also use a puppet one-liner to get epel onto a system.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
39
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
40 puppet apply -e 'include epel'
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
41
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
42 # Proxy
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
43 If you have a http proxy required to access the internet, you can use either
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
44 a class parameter in the _epel_ class (epel_proxy), or edit the $proxy variable
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
45 in the params.pp file. By default no proxy is assumed.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
46
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
47 # Why?
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
48 I am a big fan of EPEL. I actually was one of the people who helped get it
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
49 going. I am also the owner of the epel-release package, so in general this
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
50 module should stay fairly up to date with the official upstream package.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
51
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
52 I just got sick of coding Puppet modules and basically having an assumption
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
53 that EPEL was setup or installed. I can now depend on this module instead.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
54
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
55 I realize it is fairly trivial to get EPEL setup. Every now-and-then however
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
56 the path to epel-release changes because something changes in the package (mass
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
57 rebuild, rpm build macros updates, etc). This module will bypass the changing
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
58 URL and just setup the package mirrors.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
59
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
60 This does mean that if you are looking for RPM macros that are normally
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
61 included with EPEL release, this will not have them.
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
62
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
63 # Further Information
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
64
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
65 * [EPEL Wiki](http://fedoraproject.org/wiki/EPEL)
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
66 * [epel-release package information](http://mirrors.servercentral.net/fedora/epel/6/i386/repoview/epel-release.html)
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
67
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
68 # Testing and Compatibility
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
69
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
70 * This module is tested on CentOS 6, 7 and 8 with Puppet 5 and Puppet 6.
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
71 * It should work on any RHEL variant such as RedHat, OracleLinux, Scientific Linux etc.
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
72 * Amazon Linux compatability is not promised, as EPEL doesn't always work with it.
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
73 * Support for EL5 is deprecated. It *may* still work but we have no acceptance tests. CentOS 5 is EOL and RHEL5 and OracleLinux 5 extended support for most customers is due to end in 2020.
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
74
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
75 ## Unit tests
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
76
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
77 Install the necessary gems
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
78
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
79 bundle install --path vendor --without system_tests
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
80
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
81 Run the RSpec and puppet-lint tests
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
82
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
83 bundle exec rake test
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
84
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
85 ## System tests
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
86
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
87 If you have Vagrant >=1.1.0 you can also run system tests:
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
88
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
89 RSPEC_SET=centos-64-x64 bundle exec rake spec:system
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
90
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
91 Available RSPEC_SET options are in .nodeset.yml
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
92
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
93 # License
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
94
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
95 This module is distributed under the [Apache License 2.0](LICENSE).
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
96 Since version 3, it is maintained by [Vox Pupuli](https://voxpupuli.org/).
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
97
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
98 # Author/Contributors
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
99 * Aaron <slapula@users.noreply.github.com>
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
100 * Alex Harvey <Alex_Harvey@amp.com.au>
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
101 * Chad Metcalf <metcalfc@gmail.com>
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
102 * Ewoud Kohl van Wijngaarden <e.kohlvanwijngaarden@oxilion.nl>
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
103 * Jeffrey Clark <jclark@nmi.com>
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
104 * Joseph Swick <joseph.swick@meltwater.com>
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
105 * Matthaus Owens <mlitteken@gmail.com>
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
106 * Michael Hanselmann <hansmi@vshn.ch>
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
107 * Michael Stahnke <stahnma@fedoraproject.org>
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
108 * Michael Stahnke <stahnma@puppet.com>
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
109 * Michael Stahnke <stahnma@puppetlabs.com>
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
110 * Michael Stahnke <stahnma@websages.com>
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
111 * Mickaël Canévet <mickael.canevet@camptocamp.com>
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
112 * Nick Le Mouton <nick@noodles.net.nz>
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
113 * Pro Cabales <proletaryo@gmail.com>
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
114 * Proletaryo Cabales <proletaryo@gmail.com>
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
115 * Riccardo Calixte <rcalixte@broadinstitute.org>
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
116 * Robert Story <rstory@localhost>
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
117 * Rob Nelson <rnelson0@gmail.com>
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
118 * Siebrand Mazeland <siebrand@kitano.nl>
272
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
119 * Stefan Goethals <stefan@zipkid.eu>
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
120 * Tim Rupp <caphrim007@gmail.com>
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
121 * Toni Schmidbauer <toni@stderr.at>
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
122 * Trey Dockendorf <treydock@gmail.com>
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
123 * Troy Bollinger <troy@us.ibm.com>
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
124 * Vlastimil Holer <holer@ics.muni.cz>
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
125
c42fb28cff86 Update to a newer Python module
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
126 # Alternatives
387
66c075c5f54a Update to newer Python module
IBBoard <dev@ibboard.co.uk>
parents: 272
diff changeset
127 If you're on CentOS 7 or CentOS 8, you can just `yum install epel-release` as it's in centos-extras.