README.md 5.68 KB
Newer Older
Tim Smith's avatar
Tim Smith committed
1
# yum-epel Cookbook
2

Lance Albertson's avatar
Lance Albertson committed
3
4
5
6
7
[![Cookbook Version](https://img.shields.io/cookbook/v/yum-epel.svg)](https://supermarket.chef.io/cookbooks/yum-epel)
[![CI State](https://github.com/sous-chefs/yum-epel/workflows/ci/badge.svg)](https://github.com/sous-chefs/yum-epel/actions?query=workflow%3Aci)
[![OpenCollective](https://opencollective.com/sous-chefs/backers/badge.svg)](#backers)
[![OpenCollective](https://opencollective.com/sous-chefs/sponsors/badge.svg)](#sponsors)
[![License](https://img.shields.io/badge/License-Apache%202.0-green.svg)](https://opensource.org/licenses/Apache-2.0)
Sean OMeara's avatar
Sean OMeara committed
8

9
10
Extra Packages for Enterprise Linux (or EPEL) is a Fedora Special Interest Group that creates, maintains, and manages a high quality set of additional packages for Enterprise Linux, including, but not limited to, Red Hat Enterprise Linux (RHEL), CentOS and Scientific Linux (SL), Oracle Linux (OL).

Lance Albertson's avatar
Lance Albertson committed
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
The yum-epel cookbook takes over management of the default repositoryids shipped with epel-release.

Below is a table showing which repositoryids we manage that are shipped by default via the epel-release package:

| Repo ID                        | EL 7             | EL 8             |
| ------------------------------ | :--------------: | :--------------: |
| epel                           |:heavy_check_mark:|:heavy_check_mark:|
| epel-debuginfo                 |:heavy_check_mark:|:heavy_check_mark:|
| epel-modular                   |       :x:        |:heavy_check_mark:|
| epel-modular-debuginfo         |       :x:        |:heavy_check_mark:|
| epel-modular-source            |       :x:        |:heavy_check_mark:|
| epel-playground                |       :x:        |:heavy_check_mark:|
| epel-playground-debuginfo      |       :x:        |:heavy_check_mark:|
| epel-playground-source         |       :x:        |:heavy_check_mark:|
| epel-source                    |:heavy_check_mark:|:heavy_check_mark:|
| epel-testing                   |:heavy_check_mark:|:heavy_check_mark:|
| epel-testing-debuginfo         |:heavy_check_mark:|:heavy_check_mark:|
| epel-testing-modular           |       :x:        |:heavy_check_mark:|
| epel-testing-modular-debuginfo |       :x:        |:heavy_check_mark:|
| epel-testing-modular-source    |       :x:        |:heavy_check_mark:|
| epel-testing-source            |:heavy_check_mark:|:heavy_check_mark:|
Sean OMeara's avatar
Sean OMeara committed
32

Tim Smith's avatar
Tim Smith committed
33
## Requirements
34

Tim Smith's avatar
Tim Smith committed
35
### Platforms
36

Tim Smith's avatar
Tim Smith committed
37
- RHEL/CentOS and derivatives
Tim Smith's avatar
Tim Smith committed
38

Tim Smith's avatar
Tim Smith committed
39
### Chef
40

41
- Chef 12.15+
Tim Smith's avatar
Tim Smith committed
42

Lance Albertson's avatar
Lance Albertson committed
43
44
45
46
## Maintainers

This cookbook is maintained by the Sous Chefs. The Sous Chefs are a community of Chef cookbook maintainers working together to maintain important cookbooks. If you’d like to know more please visit [sous-chefs.org](https://sous-chefs.org/) or come chat with us on the Chef Community Slack in [#sous-chefs](https://chefcommunity.slack.com/messages/C2V7B88SF).

Tim Smith's avatar
Tim Smith committed
47
### Cookbooks
48

49
- none
Tim Smith's avatar
Tim Smith committed
50

Tim Smith's avatar
Tim Smith committed
51
## Attributes
52

Lance Albertson's avatar
Lance Albertson committed
53
See individual repository attribute files for defaults.
Sean OMeara's avatar
Sean OMeara committed
54

Tim Smith's avatar
Tim Smith committed
55
## Recipes
56

Lance Albertson's avatar
Lance Albertson committed
57
- `yum-epel::default` Generates `yum_repository` configs for the standard EPEL repositories. By default the `epel` repository is enabled.
Sean OMeara's avatar
Sean OMeara committed
58

Tim Smith's avatar
Tim Smith committed
59
## Usage Example
60

Sean OMeara's avatar
Sean OMeara committed
61
62
63
64
65
66
67
68
69
70
71
72
73
74
To disable the epel repository through a Role or Environment definition

```
default_attributes(
  :yum => {
    :epel => {
      :enabled => {
        false
       }
     }
   }
 )
```

Tim Smith's avatar
Tim Smith committed
75
Uncommonly used repositoryids are not managed by default. This is speeds up integration testing pipelines by avoiding yum-cache builds that nobody cares about. To enable the epel-testing repository with a wrapper cookbook, place the following in a recipe:
Sean OMeara's avatar
Sean OMeara committed
76

Tim Smith's avatar
Tim Smith committed
77
```ruby
Sean OMeara's avatar
Sean OMeara committed
78
node.default['yum']['epel-testing']['enabled'] = true
79
node.default['yum']['epel-testing']['managed'] = true
Sean OMeara's avatar
Sean OMeara committed
80
81
82
include_recipe 'yum-epel'
```

Tim Smith's avatar
Tim Smith committed
83
## More Examples
84

Sean OMeara's avatar
Sean OMeara committed
85
86
Point the epel repositories at an internally hosted server.

Tim Smith's avatar
Tim Smith committed
87
```ruby
Sean OMeara's avatar
Sean OMeara committed
88
89
node.default['yum']['epel']['enabled'] = true
node.default['yum']['epel']['mirrorlist'] = nil
90
node.default['yum']['epel']['baseurl'] = 'https://internal.example.com/centos/7/os/x86_64'
Sean OMeara's avatar
Sean OMeara committed
91
92
93
94
95
node.default['yum']['epel']['sslverify'] = false

include_recipe 'yum-epel'
```

Lance Albertson's avatar
Lance Albertson committed
96
## Contributors
97

Lance Albertson's avatar
Lance Albertson committed
98
This project exists thanks to all the people who [contribute.](https://opencollective.com/sous-chefs/contributors.svg?width=890&button=false)
Sean OMeara's avatar
Sean OMeara committed
99

Lance Albertson's avatar
Lance Albertson committed
100
### Backers
Tim Smith's avatar
Tim Smith committed
101

Lance Albertson's avatar
Lance Albertson committed
102
Thank you to all our backers!
Sean OMeara's avatar
Sean OMeara committed
103

Lance Albertson's avatar
Lance Albertson committed
104
![https://opencollective.com/sous-chefs#backers](https://opencollective.com/sous-chefs/backers.svg?width=600&avatarHeight=40)
Sean OMeara's avatar
Sean OMeara committed
105

Lance Albertson's avatar
Lance Albertson committed
106
107
108
109
110
111
112
113
114
115
116
117
118
119
### Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website.

![https://opencollective.com/sous-chefs/sponsor/0/website](https://opencollective.com/sous-chefs/sponsor/0/avatar.svg?avatarHeight=100)
![https://opencollective.com/sous-chefs/sponsor/1/website](https://opencollective.com/sous-chefs/sponsor/1/avatar.svg?avatarHeight=100)
![https://opencollective.com/sous-chefs/sponsor/2/website](https://opencollective.com/sous-chefs/sponsor/2/avatar.svg?avatarHeight=100)
![https://opencollective.com/sous-chefs/sponsor/3/website](https://opencollective.com/sous-chefs/sponsor/3/avatar.svg?avatarHeight=100)
![https://opencollective.com/sous-chefs/sponsor/4/website](https://opencollective.com/sous-chefs/sponsor/4/avatar.svg?avatarHeight=100)
![https://opencollective.com/sous-chefs/sponsor/5/website](https://opencollective.com/sous-chefs/sponsor/5/avatar.svg?avatarHeight=100)
![https://opencollective.com/sous-chefs/sponsor/6/website](https://opencollective.com/sous-chefs/sponsor/6/avatar.svg?avatarHeight=100)
![https://opencollective.com/sous-chefs/sponsor/7/website](https://opencollective.com/sous-chefs/sponsor/7/avatar.svg?avatarHeight=100)
![https://opencollective.com/sous-chefs/sponsor/8/website](https://opencollective.com/sous-chefs/sponsor/8/avatar.svg?avatarHeight=100)
![https://opencollective.com/sous-chefs/sponsor/9/website](https://opencollective.com/sous-chefs/sponsor/9/avatar.svg?avatarHeight=100)