Skip to content
Development repository for yum cookbook
Branch: master
Clone or download
Latest commit 7c04518 Jan 11, 2019

yum Cookbook

Build Status Cookbook Version

The Yum cookbook exposes the yum_globalconfig resource which allows a user to control global yum behavior. This resources aims to allow the user to configure all options listed in the yum.conf man page, found at



  • RHEL/CentOS and derivatives
  • Fedora


  • Chef 12.14+


  • none



This renders a template with global yum configuration parameters. The default recipe uses it to render /etc/yum.conf. It is flexible enough to be used in other scenarios, such as building RPMs in isolation by modifying installroot.


yum_globalconfig '/my/chroot/etc/yum.conf' do
  cachedir '/my/chroot/etc/yum.conf'
  keepcache 'yes'
  debuglevel '2'
  installroot '/my/chroot'
  action :create


yum_globalconfig can take most of the same parameters as a yum_repository, plus more, too numerous to describe here. Below are a few of the more commonly used ones. For a complete list, please consult the yum.conf man page, found here:

  • cachedir - Directory where yum should store its cache and db files. The default is '/var/cache/yum'.
  • keepcache - Either true or false. Determines whether or not yum keeps the cache of headers and packages after successful installation. Default is false
  • debuglevel - Debug message output level. Practical range is 0-10. Default is '2'.
  • exclude - List of packages to exclude from updates or installs. This should be a space separated list. Shell globs using wildcards (eg. * and ?) are allowed.
  • installonlypkgs = List of package provides that should only ever be installed, never updated. Kernels in particular fall into this category. Defaults to kernel, kernel-bigmem, kernel-enterprise, kernel-smp, kernel-debug, kernel-unsupported, kernel-source, kernel-devel, kernel-PAE, kernel-PAE-debug.
  • logfile - Full directory and file name for where yum should write its log file.
  • exactarch - Either true or false. Set to true to make 'yum update' only update the architectures of packages that you have installed. ie: with this enabled yum will not install an i686 package to update an x86_64 package. Default is true
  • gpgcheck - Either true or false. This tells yum whether or not it should perform a GPG signature check on the packages gotten from this repository.


This resource is now provided by chef-client 12.14 and later and has been removed from this cookbook. If you require this resource we highly recommend upgrading your chef-client, but if that is not an option you can pin the 4.X yum cookbook.


  • default - Configures yum_globalconfig[/etc/yum.conf] with values found in node attributes at node['yum']['main']
  • dnf_yum_compat - Installs the yum package using dnf on Fedora systems to provide support for the package resource in recipes. This is necessary on chef-client < 12.18. This recipe should be 1st on a Fedora runlist


The following attributes are set by default

default['yum']['main']['cachedir'] = '/var/cache/yum/$basearch/$releasever'
default['yum']['main']['keepcache'] = false
default['yum']['main']['debuglevel'] = nil
default['yum']['main']['exclude'] = nil
default['yum']['main']['logfile'] = '/var/log/yum.log'
default['yum']['main']['exactarch'] = nil
default['yum']['main']['obsoletes'] = nil
default['yum']['main']['installonly_limit'] = nil
default['yum']['main']['installonlypkgs'] = nil
default['yum']['main']['installroot'] = nil

For Amazon platform nodes, the default is to receive a continuous flow of updates,

default['yum']['main']['releasever'] = 'latest'

To lock existing instances to the current version of the Amazon AMI,

default['yum']['main']['releasever'] = ''

Related Cookbooks

Recipes from older versions of this cookbook have been moved individual cookbooks. Recipes for managing platform yum configurations and installing specific repositories can be found in one (or more!) of the following cookbook.

  • yum-centos
  • yum-fedora
  • yum-amazon
  • yum-epel
  • yum-elrepo
  • yum-repoforge
  • yum-ius
  • yum-percona
  • yum-pgdg


Put depends 'yum' in your metadata.rb to gain access to the yum_repository resource.

License & Authors

Copyright:: 2011 Eric G. Wolfe
Copyright:: 2013-2017 Chef Software, Inc.

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

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.
You can’t perform that action at this time.