Yum

Module description

This module provides helpful definitions for dealing with yum.

Requirements

Module has been tested on:

• Puppet 4.10.9 and newer
• CentOS 6, 7
• Amazon Linux 2017
• RHEL 7
• Fedora 30 (partial support)

Usage

Manage global Yum configuration via the primary class

class { 'yum':
  keep_kernel_devel => false|true,
  clean_old_kernels => false|true,
  config_options    => {
      my_cachedir => {
        ensure => '/home/waldo/.local/yum/cache',
        key    => 'cachedir',
      },
      gpgcheck    => true,
      debuglevel  => 5,
      assumeyes   => {
        ensure => 'absent',
      },
    },
  },
}

NOTE: The config_options parameter takes a Hash where keys are the names of Yum::Config resources and the values are either the direct ensure value (gpgcheck or debuglevel in the example above), or a Hash of the resource's attributes (my_cachedir or assumeyes in the example above). Values may be Strings, Integers, or Booleans. Booleans will be converted to either a 1 or 0; use a quoted string to get a literal true or false.

If installonly_limit is changed, purging of old kernel packages is triggered if clean_old_kernels is true.

Manage yum.conf entries via defined types

yum::config { 'installonly_limit':
  ensure => 2,
}

yum::config { 'debuglevel':
  ensure => absent,
}

Manage a custom repo via Hiera data

Using Hiera and automatic parameter lookup (APL), this module can manage Yumrepos. The repos parameter takes a hash of hashes, where the first-level keys are the Yumrepo resource names and their value hashes contain parameters and values to feed into the resource definition. On its own, the repos parameter does nothing. The resource names from the hash must be selected via the managed_repos parameter. This example defines a custom repo.

First, include the class.

include 'yum'

In Hiera data, add the name of the repo to the yum::managed_repos key (an Array), and define the repo in the yum::repos key:

---
yum::managed_repos:
    - 'example_repo'
yum::repos:
    example_repo:
        ensure: 'present'
        enabled: true
        descr: 'Example Repo'
        baseurl: 'https://repos.example.com/example/'
        gpgcheck: true
        gpgkey: 'file:///etc/pki/gpm-gpg/RPM-GPG-KEY-Example'
        target: '/etc/yum.repos.d/example.repo'

You can include gpgkeys in yaml as well, and if the key filename matches a gpgkey from a mananged repo, it will be included. For example a gpg key for the repo above could look like:

---
yum::gpgkeys:
    /etc/pki/gpm-gpg/RPM-GPG-KEY-Example:
        content: |
            -----BEGIN PGP PUBLIC KEY BLOCK-----
            Version: GnuPG v1.4.11 (GNU/Linux)

            mQINBFKuaIQBEAC1UphXwMqCAarPUH/ZsOFslabeTVO2pDk5YnO96f+rgZB7xArB
            OSeQk7B90iqSJ85/c72OAn4OXYvT63gfCeXpJs5M7emXkPsNQWWSju99lW+AqSNm
            (SNIP SEVERAL LINES)
            RjsC7FDbL017qxS+ZVA/HGkyfiu4cpgV8VUnbql5eAZ+1Ll6Dw==
            =hdPa
            -----END PGP PUBLIC KEY BLOCK-----

... or

---
yum::gpgkeys:
    /etc/pki/gpm-gpg/RPM-GPG-KEY-Example:
        source: puppet:///repos/RPM-GPG-KEY-Example

Enable management of one of the pre-defined repos

This module includes several pre-defined Yumrepos for easy management. This example enables management of the EPEL repository using its default settings.

NOTE: This only works if the data for the repository is included with the module. Please see the /data directory of this module for a list of available repos.

include 'yum'

---
yum::managed_repos:
    - 'epel'

Enable management of one of the pre-defined repos AND modify its settings

Here the Extras repository for CentOS is enabled and its settings are modified. Because the repos parameter uses a deep merge strategy when fed via automatic parameter lookup (APL), only the values requiring modification need be defined.

To clear a value set below (from default repos, or lower in the hierarchy), pass it the knockout prefix, --. This will blank out the value.

---
yum::managed_repos:
    - 'extras'
yum::repos:
    extras:
        enabled: true
        baseurl: 'https://myrepo.example.com/extras'
        gpgcheck: false
        gpgkey: '--'

The built-in repos by default have data in mirrorlist, but baseurl is undefined. Using the knockout prefix won't work with mirrorlist, as it requires a valid URL or the value absent, as shown at https://puppet.com/docs/puppet/latest/types/yumrepo.html.

---
yum::managed_repos:
    - 'extras'
yum::repos:
    extras:
        enabled: true
        baseurl: 'https://mirror.example.com/extras'
        mirrorlist: 'absent'

Enable managemnt of multiple repos

The managed_repos parameter uses the unique Hiera merge strategy, so it's possible to define repos to be managed at multiple levels of the hierarchy. For example, given the following hierarchy and the following two yaml files, the module would receive the array ['base', 'extras', 'debug'].

---
hierarchy:
    - name: 'Common'
      paths:
        - "%{trusted.certname}"
        - 'common.yaml'

---
# node01
yum::managed_repos:
    - 'base'
    - 'debug'

# common
yum::managed_repos:
    - 'base'
    - 'extras'

Negate previously enabled repos

The repo_exclusions parameter is used to exclude repos from management. It is mainly useful in complex Hiera hierarchies where repos need to be removed from a baseline. Here we define a baseline set of repos in common.yaml, but disable one of them for a specific node.

---
hierarchy:
    - name: 'Common'
      paths:
        - "%{trusted.certname}"
        - 'common.yaml'

---
# node01
yum::repo_exclusions:
    - 'updates' #yolo

---
# common
yum::managed_repos:
    - 'base'
    - 'updates'
    - 'extras'

Enable management of the default OS Yumrepos

This module includes the boolean helper parameter manage_os_default_repos easily select select OS repos. It uses module data to add the appropriate repos to the managed_repos parameter based on OS facts. Just like adding them manually, they can be negated via the repo_exclusions parameter.

NOTE: This only works for operating systems who's Yumrepos are defined in the module's data AND who's default repos are defined in the module's data.

On a CentOS 7 machine these two snippets are functionally equivalent.

class { 'yum':
  manage_os_default_repos => true,
}

class { 'yum':
  managed_repos => [
    'base',
    'updates',
    'extras',
    'centosplus',
    'base-source',
    'updates-source',
    'extras-source',
    'base-debuginfo',
    'centos-media',
    'cr',
  ]
}

Add/remove a GPG RPM signing key using an inline key block

yum::gpgkey { '/etc/pki/rpm-gpg/RPM-GPG-KEY-puppet-smoketest1':
  ensure  => present,
  content => '-----BEGIN PGP PUBLIC KEY BLOCK-----
...
-----END PGP PUBLIC KEY BLOCK-----',
}

Add/remove a GPGP RPM signing key using a key stored on a Puppet fileserver

yum::gpgkey { '/etc/pki/rpm-gpg/RPM-GPG-KEY-elrepo.org':
  ensure => present,
  source => 'puppet:///modules/elrepo/RPM-GPG-KEY-elrepo.org',
}

Install or remove yum plugin

yum::plugin { 'versionlock':
  ensure => present,
}

Lock a package with the versionlock plugin

Locks explicitly specified packages from updates. Package name must be precisely specified in format EPOCH:NAME-VERSION-RELEASE.ARCH. Wild card in package name is allowed provided it does not span a field seperator.

yum::versionlock { '0:bash-4.1.2-9.el6_2.*':
  ensure => present,
}

Use the following command to retrieve a properly-formated string:

PACKAGE_NAME='bash'
rpm -q "$PACKAGE_NAME" --qf '%|EPOCH?{%{EPOCH}}:{0}|:%{NAME}-%{VERSION}-%{RELEASE}.%{ARCH}\n'

To run a yum clean all after the versionlock file is updated.

class{'yum::plugin::versionlock':
  clean => true,
}
yum::versionlock { '0:bash-4.1.2-9.el6_2.*':
  ensure => present,
}

Install or remove yum package group

Install yum package groups. To list groups: yum group list. Then use that name in your puppet manifest. With support for install_options (e.g. enable repos if disabled by default).

yum::group { 'X Window System':
  ensure          => present,
  timeout         => 600,
  install_options => ['--enablerepo=*'];
}

Install or remove packages via yum install

This is a workaround for PUP-3323. It enables the installation of packages from non-repo sources while still providing dependency resolution. For example, say there is a package foo that requires the package bar. bar is in a Yum repository and foo is stored on a stand-alone HTTP server. Using the standard providers for the Package resource type, rpm and yum, the rpm provider would be required to install foo, because only it can install from a non-repo source, i.e., a URL. However, since the rpm provider cannot do dependency resolution, it would fail on its own unless bar was already installed. This workaround enables foo to be installed without having to define its dependencies in Puppet.

From URL:

yum::install { 'package-name':
  ensure => present,
  source => 'http://example.com/path/to/package/filename.rpm',
}

From local filesystem:

yum::install { 'package-name':
  ensure => present,
  source => 'file:///path/to/package/filename.rpm',
}

Please note that resource name must be same as installed package name.

Puppet tasks

The module has a puppet task that allows to run yum update or yum upgrade. This task needs puppet agent installed on the remote.

Please refer to the Bolt documentation on how to execute a task.

$ bolt task show yum

yum - Allows you to perform yum functions

USAGE:
bolt task run --nodes <node-name> yum action=<value> [quiet=<value>]

PARAMETERS:
- action: Enum['update', 'upgrade']
    Action to perform
- quiet: Optional[Boolean]
    Run without output

Fedora partial support

Support for fedora is minimal at this time. The yum class can be included without error and resources such as yum::group can be managed. No repositories or GPG keys are managed by default. Old kernel cleanup is known not to work, and plugins may not work due to different package naming. Pull requests for additional support would be welcomed.

This module was donated by CERIT Scientific Cloud, support@cerit-sc.cz to Vox Pupuli

Reference

Table of Contents

Classes

• yum: A class to install and manage Yum configuration.
• yum::clean: A $(yum clean all) Exec to be notified if desired.
• yum::plugin::versionlock: Class: yum::plugin::versionlock This class installs versionlock plugin Parameters: [ensure] - specifies if versionlock should be presen

Defined types

• yum::config: Define: yum::config This definition manages yum.conf Parameters: [key] - alternative conf. key (defaults to name) [ensure] -
• yum::gpgkey: Define: yum::gpgkey This definition saves and imports public GPG key for RPM. Key can be stored on Puppet's fileserver or as inline content.
• yum::group: Define: yum::group This definition installs or removes yum package group. Parameters: [ensure] - specifies if package group should be
• yum::install: Define: yum::install This definition installs or removes rpms from local file or URL via yum install command. This can be better than using
• yum::plugin: Define: yum::plugin This definition installs Yum plugin. Parameters: [ensure] - specifies if plugin should be present or absent Acti
• yum::versionlock: Locks package from updates.

Functions

• yum::bool2num_hash_recursive: This functions converts the Boolean values of a Hash to Integers, either '0' or '1'. It does this recursively, decending as far as the langu

Data types

• Yum::VersionlockString: This type matches strings appropriate for use with yum-versionlock. Its basic format, using the rpm(8) query string format, is `%{EPOCH}:%{

Tasks

• init: Allows you to perform yum functions

Classes

yum

A class to install and manage Yum configuration.

Examples

Enable management of the default repos for a supported OS:

```yaml
---
yum::manage_os_default_repos: true

##### Add Hiera data to disable *management* of the CentOS Base repo:

```puppet
```yaml
---
yum::manage_os_default_repos: true
yum::repo_exclusions:
    - 'base'

##### Ensure the CentOS base repo is removed from the agent system(s):

```puppet
```yaml
---
yum::manage_os_default_repos: true
yum::repos:
    base:
        ensure: 'absent'

##### Add a custom repo:

```puppet
```yaml
---
yum::managed_repos:
    - 'example_repo'
yum::repos:
    example_repo:
        ensure: 'present'
        enabled: true
        descr: 'Example Repo'
        baseurl: 'https://repos.example.com/example/'
        gpgcheck: true
        gpgkey: 'file:///etc/pki/gpm-gpg/RPM-GPG-KEY-Example'
        target: '/etc/yum.repos.d/example.repo'

##### Use a custom `baseurl` for the CentOS Base repo:

```puppet
```yaml
---
yum::manage_os_default_repos: true
yum::repos:
    base:
        baseurl: 'https://repos.example.com/CentOS/base/'
        mirrorlist: '--'

#### Parameters

The following parameters are available in the `yum` class.

##### `clean_old_kernels`

Data type: `Boolean`

Whether or not to purge old kernel version beyond the `keeponly_limit`.

Default value: `true`

##### `keep_kernel_devel`

Data type: `Boolean`

Whether or not to keep kernel devel packages on old kernel purge.

Default value: `false`

##### `config_options`

Data type: `Hash[String, Variant[String, Integer, Boolean, Hash[String, Variant[String, Integer, Boolean]]]]`

A Hash where keys are the names of `Yum::Config` resources and the values
are either the direct `ensure` value, or a Hash of the resource's attributes.

@note Boolean parameter values will be converted to either a `1` or `0`; use a quoted string to
  get a literal `true` or `false`.

Default value: { }

##### `repos`

Data type: `Optional[Hash[String, Optional[Hash[String, Variant[String, Integer, Boolean]]]]]`

A hash where keys are the names of `Yumrepo` resources and each value represents its respective
Yumrepo's resource parameters.  This is used in conjunction with the `managed_repos` parameter
to create `Yumrepo` resources en masse.  Some default data is provided for this using module
data.  It is configured to deep merge with a `knockout_prefix` of `--` by default, so individual
parameters may be overriden or removed via global or environment Hiera data.

@note Boolean parameter values will be converted to either a `1` or `0`; use a quoted string to
  get a literal `true` or `false`.

Default value: {}

##### `managed_repos`

Data type: `Array[String]`

An array of first-level keys from the `repos` hash to include in the catalog.  The module uses
this list to select `Yumrepo` resources from the `repos` hash for instantiation.  Defaults are
set in the module's Hiera data.

@note This only indicates the *managed* state of the repos, the `ensure` state must be managed
  in the `repos` data.

Default value: []

##### `manage_os_default_repos`

Data type: `Boolean`

Whether or not to add an operating system's default repos to the `managed_repos` array.

@note This only works for operating systems with data in the module's data directory.  Currently
  the module only contains data for for CentOS 6 & 7.

Default value: `false`

##### `os_default_repos`

Data type: `Array[String]`

A list of default repos to add to `managed_repos` if `manage_os_default_repos` is enabled.
Normally this should not be modified.

Default value: []

##### `repo_exclusions`

Data type: `Array[String]`

An array of first-level keys from the `repos` hash to exclude from management via this module.
Values in this array will be subtracted from the `managed_repos` array as a last step before
instantiation.

Default value: []

##### `gpgkeys`

Data type: `Hash[String, Hash[String, String]]`

A hash of yum::gpgkey types, which will be automatically included if they
are referenced by a managed_repo. This will use the same merging behavior
as repos.

Default value: {}

##### `utils_package_name`

Data type: `String`

Name of the utils package, e.g. 'yum-utils', or 'dnf-utils'.

Default value: 'yum-utils'

### yum::clean

A $(yum clean all) Exec to be notified if desired.

### yum::plugin::versionlock

Class: yum::plugin::versionlock

This class installs versionlock plugin

Parameters:
  [*ensure*] - specifies if versionlock should be present or absent
  [*clean*] - specifies if yum clean all should be called after edits. Defaults false.

Actions:

Requires:

Sample usage:
  include yum::plugin::versionlock

#### Parameters

The following parameters are available in the `yum::plugin::versionlock` class.

##### `ensure`

Data type: `Enum['present', 'absent']`



Default value: 'present'

##### `path`

Data type: `String`



Default value: '/etc/yum/pluginconf.d/versionlock.list'

##### `clean`

Data type: `Boolean`



Default value: `false`

## Defined types

### yum::config

Define: yum::config

This definition manages yum.conf

Parameters:
  [*key*]      - alternative conf. key (defaults to name)
  [*ensure*]   - specifies value or absent keyword
  [*section*]  - config section (default to main)

Actions:

Requires:
  RPM based system

Sample usage:
  yum::config { 'installonly_limit':
    ensure => 2,
  }

  yum::config { 'debuglevel':
    ensure => absent,
  }

#### Parameters

The following parameters are available in the `yum::config` defined type.

##### `ensure`

Data type: `Variant[Boolean, Integer, Enum['absent'], String]`



##### `key`

Data type: `String`



Default value: $title

### yum::gpgkey

Define: yum::gpgkey

This definition saves and imports public GPG key for RPM. Key can
be stored on Puppet's fileserver or as inline content. Key can be
also removed from system.

Parameters:
  [*path*]     - alternative file location (defaults to name)
  [*ensure*]   - specifies if key should be present or absent
  [*content*]  - content
  [*source*]   - source (e.g.: puppet:///)
  [*owner*]    - file owner
  [*group*]    - file group
  [*mode*]     - file mode

Actions:

Requires:
  RPM based system

Sample usage:
  yum::gpgkey { '/etc/pki/rpm-gpg/RPM-GPG-KEY-puppet-smoketest1':
    ensure  => 'present',
    content => '-----BEGIN PGP PUBLIC KEY BLOCK-----
  ...
  -----END PGP PUBLIC KEY BLOCK-----';
  }

#### Parameters

The following parameters are available in the `yum::gpgkey` defined type.

##### `path`

Data type: `String`



Default value: $name

##### `ensure`

Data type: `Enum['present', 'absent']`



Default value: 'present'

##### `content`

Data type: `Optional[String]`



Default value: `undef`

##### `source`

Data type: `Optional[String]`



Default value: `undef`

##### `owner`

Data type: `String`



Default value: 'root'

##### `group`

Data type: `String`



Default value: 'root'

##### `mode`

Data type: `String`



Default value: '0644'

### yum::group

Define: yum::group

This definition installs or removes yum package group.

Parameters:
  [*ensure*]   - specifies if package group should be
                 present (installed) or absent (purged)
  [*timeout*]  - exec timeout for yum groupinstall command
  [*install_options*]  - options provided to yum groupinstall command

Actions:

Requires:
  RPM based system

Sample usage:
  yum::group { 'X Window System':
    ensure  => 'present',
  }

#### Parameters

The following parameters are available in the `yum::group` defined type.

##### `install_options`

Data type: `Array[String[1]]`



Default value: []

##### `ensure`

Data type: `Enum['present', 'installed', 'latest', 'absent', 'purged']`



Default value: 'present'

##### `timeout`

Data type: `Optional[Integer]`



Default value: `undef`

### yum::install

Define: yum::install

This definition installs or removes rpms from local file or URL via
yum install command. This can be better than using just the rpm
provider because it will pull all the dependencies.

Parameters:
  [*ensure*] - specifies if package group should be
               present (installed) or absent (purged)
  [*source*] - file or URL where RPM is available

Actions:

Requires:
  RPM based system

Sample usage:
  yum::install { 'epel-release':
    ensure => 'present',
    source => 'https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm',
  }

#### Parameters

The following parameters are available in the `yum::install` defined type.

##### `source`

Data type: `String`



##### `ensure`

Data type: `Enum['present', 'installed', 'absent', 'purged']`



Default value: 'present'

##### `timeout`

Data type: `Optional[Integer]`



Default value: `undef`

### yum::plugin

Define: yum::plugin

This definition installs Yum plugin.

Parameters:
  [*ensure*]   - specifies if plugin should be present or absent

Actions:

Requires:
  RPM based system

Sample usage:
  yum::plugin { 'versionlock':
    ensure  => 'present',
  }

#### Parameters

The following parameters are available in the `yum::plugin` defined type.

##### `ensure`

Data type: `Enum['present', 'absent']`



Default value: 'present'

##### `pkg_prefix`

Data type: `Optional[String]`



Default value: `undef`

##### `pkg_name`

Data type: `Optional[String]`



Default value: `undef`

### yum::versionlock

Locks package from updates.

* **Note** The resource title must use the format
"%{EPOCH}:%{NAME}-%{VERSION}-%{RELEASE}.%{ARCH}".  This can be retrieved via
the command `rpm -q --qf '%{EPOCH}:%{NAME}-%{VERSION}-%{RELEASE}.%{ARCH}'.
If "%{EPOCH}" returns as '(none)', it should be set to '0'.  Wildcards may
be used within token slots, but must not cover seperators, e.g.,
'0:b*sh-4.1.2-9.*' covers Bash version 4.1.2, revision 9 on all
architectures.

* **See also**
http://man7.org/linux/man-pages/man1/yum-versionlock.1.html

#### Examples

##### Sample usage

```puppet
yum::versionlock { '0:bash-4.1.2-9.el6_2.*':
  ensure => present,
}

Parameters

The following parameters are available in the yum::versionlock defined type.

ensure

Data type: Enum['present', 'absent', 'exclude']

Specifies if versionlock should be present, absent or exclude.

Default value: 'present'

Functions

yum::bool2num_hash_recursive

Type: Puppet Language

This functions converts the Boolean values of a Hash to Integers, either '0' or '1'. It does this recursively, decending as far as the language implemenation will allow. Note that Structs and Arrays will be ignored, even if they contain Hashes.

Examples

Usage

```puppet
Hash $foo = {
  bar => { 'a' => true, 'b' => 'b' },
  baz => false,
  qux => [{ 'c' => true }, { 'd' => false }],
}

yum::bool2num_hash_recursive($foo)

The above would return:

{
  bar => { 'a' => 1, 'b' => 'b' },
  baz => 0,
  qux => [{ 'c' => true }, { 'd' => false }],
}

#### `yum::bool2num_hash_recursive(Hash $arg)`

This functions converts the Boolean values of a Hash to Integers,
either '0' or '1'.  It does this recursively, decending as far as the
language implemenation will allow.  Note that Structs and Arrays will
be ignored, even if they contain Hashes.

Returns: `Hash`

##### Examples

###### Usage

```puppet

```puppet
Hash $foo = {
  bar => { 'a' => true, 'b' => 'b' },
  baz => false,
  qux => [{ 'c' => true }, { 'd' => false }],
}

yum::bool2num_hash_recursive($foo)

The above would return:

{
  bar => { 'a' => 1, 'b' => 'b' },
  baz => 0,
  qux => [{ 'c' => true }, { 'd' => false }],
}

##### `arg`

Data type: `Hash`

The hash on which to operate

## Data types

### Yum::VersionlockString

This type matches strings appropriate for use with yum-versionlock.
Its basic format, using the `rpm(8)` query string format, is
`%{EPOCH}:%{NAME}-%{VERSION}-%{RELEASE}.%{ARCH}`.  As a Regex, it
breaks down into five distinct parts, plus the seperators.

  # EPOCH: An unsigned integer
  type Yum::PackageEpoch   = Regexp[/[0-9]\*]+/]

  # NAME: Any valid package name (see https://github.com/rpm-software-management/rpm/blob/master/doc/manual/spec)
  type Yum::PackageName    = Regexp[/[0-9a-zA-Z\._\+%\{\}\*-]+/]

  # VERSION: Any valid version string. The only limitation here, according to the RPM manual, is that it may not contain a dash (`-`).
  type Yum::PackageVersion = Regexp[/[^-]+/]

  # RELEASE: Any valid release string. Only limitation is that it is not a dash (`-`)
  type Yum::PackageRelease = Regexp[/[^-]+/]

  # ARCH: Matches a string such as `el7.x86_64`.  This is actuall two sub-expressions.  See below.
  type Yum::PackageArch    = Regexp[/([0-9a-zZ-Z_\*]+)(?:\.(noarch|x86_64|i386|arm|ppc64|ppc64le|sparc64|ia64|alpha|ip|m68k|mips|mipsel|mk68k|mint|ppc|rs6000|s390|s390x|sh|sparc|xtensa|\*))?/]

The `%{ARCH}` sub-expression is composed of two sub-expressions
separated by a dot (`.`), where the second part is optional.  The RPM
specification calls the first field the `DistTag`, and the second the
`BuildArch`.

   # DistTag: Any string consiting of only letters, numbers, or an underscore, e.g., `el6`, `sl7`, or `fc24`.
   type Yum::PackageDistTag   = Regexp[/[0-9a-zZ-Z_\*]+/]

   # BuildArch: Any string from the list at https://github.com/rpm-software-management/rpm/blob/master/rpmrc.in.  Strings are roughly listed from most common to least common to improve performance.
   type Yum::PackageBuildArch = Regexp[/noarch|x86_64|i386|arm|ppc64|ppc64le|sparc64|ia64|alpha|ip|m68k|mips|mipsel|mk68k|mint|ppc|rs6000|s390|s390x|sh|sparc|xtensa/]

wildcard characters may not span the fields, may not cover the
seperators.  This is an undocumented but tested limitation of
yum-versionlock.

* **Note** Each field may contain wildcard characters (`*`), but the

#### Examples

##### A complete, well-formed string: `0:bash-4.1.2-9.el6_2.x86_64'

```puppet

A well-formed string that has dropped the optional BuildArch sub-field: 0:bash-4.1.2-9.el6_2

A well-formed string using wildcards: *0:bash*-4.*-*.*

An invalid string (wildcard spans the VERSION and RELEASE fields): `0:bash-4.*-el6.x86_64

An invlaid string (wildcard spans the VERSION, RELEASE, and ARCH fields): 0:bash-*

Alias of Pattern[/^([0-9\*]+):([0-9a-zA-Z\._\+%\{\}\*-]+)-([^-]+)-([^-]+)\.(([0-9a-zZ-Z_\*]+)(?:\.(noarch|x86_64|i386|arm|ppc64|ppc64le|sparc64|ia64|alpha|ip|m68k|mips|mipsel|mk68k|mint|ppc|rs6000|s390|s390x|sh|sparc|xtensa|\*))?)$/]

Tasks

init

Allows you to perform yum functions

Supports noop? false

Parameters

action

Data type: Enum[update, upgrade]

Action to perform

quiet

Data type: Optional[Boolean]

Run without output

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.1 (2020-03-09)

Full Changelog

Fixed bugs:

• Fedora/CentOS8: Ensure yum-utils/dnf-utils are present #159 (KeithWard)

Closed issues:

• CentOS/RHEL 8 Uses DNF but utils package is provided by yum-utils. #158

Merged pull requests:

• Support ensuring all yum group packages are installed #140 (treydock)

v4.1.0 (2020-01-20)

Full Changelog

Implemented enhancements:

• add 'VirtuozzoLinux' support #147 (kBite)
• Support for DNF-based distros, and Fedora defaults #143 (optiz0r)
• Updated utils package for RHEL 8 #137 (rcalixte)

Fixed bugs:

• require (not contain) yum::plugin::versionlock #154 (alexjfisher)

Merged pull requests:

• instantiate yumrepo & yum::config directly #148 (igalic)
• Clean up acceptance spec helper #146 (ekohl)
• use $facts when accessing os fact #144 (igalic)
• add requirement expression in metadata of task #138 (Dan33l)
• Update concat dependency to allow puppetlabs/concat 6.x #136 (treydock)
• Allow puppetlabs/stdlib 6.x #135 (alexjfisher)

v4.0.0 (2019-05-07)

Full Changelog

Breaking changes:

• modulesync 2.7.0 and drop puppet 4 #133 (bastelfreak)

Implemented enhancements:

• Add optional parameters to groupinstall #86 (jfroche)

Fixed bugs:

• Correctly calculate rpmname for all gpg versions #126 (towo)
• Puppet 6 issue and knockout_prefix problem #121 (avidspartan1)

Closed issues:

• gpgkey applied on every run due to output change #125
• In Puppet 6, remove_undef_values doesn't work as expected #120
• --knock-out-prefix "--" knocks out valid content of yum::gpgkeys #111
• removal of mirrorlist is set by 'absent' not by using a knockout. #63

Merged pull requests:

• replace deprecated has_key() with in #129 (bastelfreak)

v3.1.1 (2018-10-14)

Full Changelog

Closed issues:

• Import GPG keys of unmanaged repos #114

Merged pull requests:

• modulesync 2.2.0 and allow puppet 6.x #124 (bastelfreak)
• Allow puppetlabs/stdlib 5.x and puppetlabs/concat 5.x #113 (bastelfreak)

v3.1.0 (2018-07-24)

Full Changelog

Implemented enhancements:

• (#107) YUM update puppet task support #108 (catay)

Closed issues:

• feature yum update puppet task support #107

v3.0.0 (2018-07-09)

Full Changelog

Breaking changes:

• Remove fastestmirror_enabled and report_instanceid parameters #103 (Zordrak)

Implemented enhancements:

• EPEL GPG Key #95
• Clean yum metadata after versionlock file update #102 (traylenator)
• Fixes #95 Add EPEL GPG Key and logic to handle yum::gpgkeys #96 (TJM)

Fixed bugs:

• Don't litter /root/ with GPG-related files. #56 (djl)

Closed issues:

• Amazon Linux manage_os_default_repos does not compile due to unsupported parameters #100
• how does the module get the name of the package? #50

Merged pull requests:

• drop EOL OSs; fix puppet version range #101 (bastelfreak)
• Rely on beaker-hostgenerator for docker nodesets #98 (ekohl)

v2.2.1 (2018-03-28)

Full Changelog

Fixed bugs:

• Hiera 5 warning on puppet 5.3.2 #77

Closed issues:

• Unable to exclude multiple packages in yum.conf #80

Merged pull requests:

• update required Puppet version in the documentation #88 (joekohlsdorf)
• migrate Hiera 4 to Hiera 5 #87 (joekohlsdorf)

v2.2.0 (2018-01-04)

Full Changelog

Fixed bugs:

• Fix EPEL repo IDs #81 (lamawithonel)

Closed issues:

• Add RHEL repos and tests. #76
• Add support for AmazonLinux 2017 #72
• EPEL managed_repo broken #53

Merged pull requests:

• bump lowest puppet version 4.6.1->4.10.9 #85 (bastelfreak)
• Fix documentation instructions for mirrorlist #83 (jorhett)
• Run beaker tests on all supported & available docker sets #79 (ekohl)
• Add RHEL repos and update README. #75 (pillarsdotnet)

v2.1.0 (2017-11-02)

Full Changelog

Implemented enhancements:

• Add AmazonLinux 2017 compatibility. #71 (pillarsdotnet)

v2.0.2 (2017-10-10)

Full Changelog

Closed issues:

• concat dependency update #57
• Yumrepo provider fork? #32

Merged pull requests:

• Release 2.0.2 #70 (bastelfreak)
• Update README.md #69 (arjenz)
• Emtpy hiera files throw puppet 4 warnings #67 (benohara)

v2.0.1 (2017-09-01)

Full Changelog

Implemented enhancements:

• Update concat dependency #58 (cdenneen)

Fixed bugs:

• Drop empty yaml file #55 (traylenator)

Closed issues:

• Update to puppetlabs/concat 3 or 4 #66
• yum::versionlock with ensure => absent doesn't purge entries #61
• versionlock.list updated after package {} install #43

Merged pull requests:

• Contain the versionlock subclass to help with ordering around package resources #65 (bovy89)
• Support ensure => absent with yum::versionlock #62 (bovy89)

v2.0.0 (2017-06-14)

Full Changelog

Breaking changes:

• BREAKING: Config create resources pattern #37 (lamawithonel)

Implemented enhancements:

• Add module data for EPEL #44 (lamawithonel)
• Manage yumrepos via data #40 (lamawithonel)
• Update README.md #39 (Yuav)
• Be more strict about versionlock strings #38 (lamawithonel)

Fixed bugs:

• Versionlock release string may contain dots #49 (traylenator)
• Fix typo. #45 (johntconklin)
• Remove section parameter from yum::config #33 (lamawithonel)

Closed issues:

• Class[Yum]: has no parameter named 'config_options' #48
• Augeas errors arise when applying yum settings on Cent OS 6 clients #47
• Remove individual configs from init.pp, use create_resources pattern instead #36
• Fix versionlock regex #35
• yum::config fails with comma separated values #21

v1.0.0 (2017-01-14)

Full Changelog

Implemented enhancements:

• Update for Puppet 4, remove support for Puppet 3 #25 (lamawithonel)

Merged pull requests:

• Comma separated values for assumeyes #29 (matonb)

v0.10.0 (2017-01-11)

Full Changelog

Implemented enhancements:

• Bump min version_requirement for Puppet + deps #22 (juniorsysadmin)
• Add parameter clean_old_kernels #20 (treydock)
• Correct format of fixtures file. #14 (traylenator)

v0.9.15 (2016-09-26)

Full Changelog

Merged pull requests:

• Update changelog and version #12 (Yuav)
• Added basic spec tests #11 (Yuav)
• Bug: Puppet creates empty key files when using Hiera and create_resources() #7 (lklimek)
• Manage yum::versionlock with concat #6 (jpoittevin)

v0.9.14 (2016-08-15)

Full Changelog

Merged pull requests:

• Release 0.9.14 #5 (jyaworski)

v0.9.13 (2016-08-15)

Full Changelog

Merged pull requests:

• Release 0.9.13 #4 (jyaworski)

v0.9.12 (2016-08-12)

Full Changelog

v0.9.11 (2016-08-12)

Full Changelog

v0.9.10 (2016-08-12)

Full Changelog

v0.9.9 (2016-08-12)

Full Changelog

v0.9.8 (2016-08-04)

Full Changelog

0.9.8 (2016-05-30)

Full Changelog

0.9.7 (2016-05-30)

Full Changelog

0.9.6 (2015-04-29)

Full Changelog

0.9.5 (2015-04-07)

Full Changelog

0.9.4 (2014-12-08)

Full Changelog

0.9.3 (2014-11-06)

Full Changelog

0.9.2 (2014-09-02)

Full Changelog

0.9.1 (2014-08-20)

Full Changelog

* This Changelog was automatically generated by github_changelog_generator