apt

Overview

The APT module provides a simple interface for managing APT source, key, and definitions with Puppet.

Module Description

APT automates obtaining and installing software packages on *nix systems.

*Note: While this module allows the use of short keys, we STRONGLY RECOMMEND that you DO NOT USE short keys, as they pose a serious security issue in that they open you up to collision attacks.*

Setup

What APT affects:

• package/service/configuration files for APT
  • NOTE: Setting the purge_preferences or purge_preferences_d parameters to 'true' will destroy any existing configuration that was not declared with puppet. The default for these parameters is 'false'.
• your system's sources.list file and sources.list.d directory
  • NOTE: Setting the purge_sources_list and purge_sources_list_d parameters to 'true' will destroy any existing content that was not declared with Puppet. The default for these parameters is 'false'.
• system repositories
• authentication keys

Beginning with APT

To begin using the APT module with default parameters, declare the class

include apt

Puppet code that uses anything from the APT module requires that the core apt class be declared.

Usage

Using the APT module consists predominantly in declaring classes that provide desired functionality and features.

apt

apt provides a number of common resources and options that are shared by the various defined types in this module, so you MUST always include this class in your manifests.

The parameters for apt are not required in general and are predominantly for development environment use-cases.

class { 'apt':
  always_apt_update    => false,
  disable_keys         => undef,
  proxy_host           => false,
  proxy_port           => '8080',
  purge_sources_list   => false,
  purge_sources_list_d => false,
  purge_preferences_d  => false,
  update_timeout       => undef,
  fancy_progress       => undef
}

Puppet will manage your system's sources.list file and sources.list.d directory but will do its best to respect existing content.

If you declare your apt class with purge_sources_list, purge_sources_list_d, purge_preferences and purge_preferences_d set to 'true', Puppet will unapologetically purge any existing content it finds that wasn't declared with Puppet.

apt::builddep

Installs the build depends of a specified package.

apt::builddep { 'glusterfs-server': }

apt::force

Forces a package to be installed from a specific release. This class is particularly useful when using repositories, like Debian, that are unstable in Ubuntu.

apt::force { 'glusterfs-server':
  release => 'unstable',
  version => '3.0.3',
  require => Apt::Source['debian_unstable'],
}

apt_key

A native Puppet type and provider for managing GPG keys for APT is provided by this module.

apt_key { 'puppetlabs':
  ensure => 'present',
  id     => '4BD6EC30',
}

You can additionally set the following attributes:

• source: HTTP, HTTPS or FTP location of a GPG key or path to a file on the target host;
• content: Instead of pointing to a file, pass the key in as a string;
• server: The GPG key server to use. It defaults to keyserver.ubuntu.com;
• keyserver_options: Additional options to pass to --keyserver.

Because it is a native type it can be used in and queried for with MCollective.

apt::key

Adds a key to the list of keys used by APT to authenticate packages. This type uses the aforementioned apt_key native type. As such it no longer requires the wget command that the old implementation depended on.

apt::key { 'puppetlabs':
  key        => '4BD6EC30',
  key_server => 'pgp.mit.edu',
}

apt::key { 'jenkins':
  key        => 'D50582E6',
  key_source => 'http://pkg.jenkins-ci.org/debian/jenkins-ci.org.key',
}

apt::pin

Adds an apt pin for a certain release.

apt::pin { 'karmic': priority => 700 }
apt::pin { 'karmic-updates': priority => 700 }
apt::pin { 'karmic-security': priority => 700 }

Note you can also specifying more complex pins using distribution properties.

apt::pin { 'stable':
  priority        => -10,
  originator      => 'Debian',
  release_version => '3.0',
  component       => 'main',
  label           => 'Debian'
}

If you wish to pin a number of packages you may specify the packages as a space delimited string using the packages attribute or pass in an array of package names.

apt::hold

When you wish to hold a package in Puppet is should be done by passing in 'held' as the ensure attribute to the package resource. However, a lot of public modules do not take this into account and generally do not work well with an ensure of 'held'.

There is an additional issue that when Puppet is told to hold a package, it will hold it at the current version installed, there is no way to tell it in one go to install a specific version and then hold that version without using an exec resource that wraps dpkg --set-selections or apt-mark.

At first glance this could also be solved by just passing the version required to the ensure attribute but that only means that Puppet will install that version once it processes that package. It does not inform apt that we want this package to be held. In other words; if another package somehow wants to upgrade this one (because of a version requirement in a dependency), apt should not allow it.

In order to solve this you can use apt::hold. It's implemented by creating a preferences file with a priority of 1001, meaning that under normal circumstances this preference will always win. Because the priority is > 1000 apt will interpret this as 'this should be the version installed and I am allowed to downgrade the current package if needed'.

With this you can now set a package's ensure attribute to 'latest' but still get the version specified by apt::hold. You can do it like this:

apt::hold { 'vim':
  version => '2:7.3.547-7',
}

Since you might just want to hold Vim at version 7.3 and not care about the rest you can also pass in a version with a glob:

apt::hold { 'vim':
  version => '2:7.3.*',
}

apt::ppa

Adds a ppa repository using add-apt-repository.

apt::ppa { 'ppa:drizzle-developers/ppa': }

apt::release

Sets the default apt release. This class is particularly useful when using repositories, like Debian, that are unstable in Ubuntu.

class { 'apt::release':
  release_id => 'precise',
}

apt::source

Adds an apt source to /etc/apt/sources.list.d/.

apt::source { 'debian_unstable':
  comment           => 'This is the iWeb Debian unstable mirror',
  location          => 'http://debian.mirror.iweb.ca/debian/',
  release           => 'unstable',
  repos             => 'main contrib non-free',
  required_packages => 'debian-keyring debian-archive-keyring',
  key               => '46925553',
  key_server        => 'subkeys.pgp.net',
  pin               => '-10',
  include_src       => true,
  include_deb       => true
}

If you would like to configure your system so the source is the Puppet Labs APT repository

apt::source { 'puppetlabs':
  location   => 'http://apt.puppetlabs.com',
  repos      => 'main',
  key        => '4BD6EC30',
  key_server => 'pgp.mit.edu',
}

Facts

There are a few facts included within the apt module describing the state of the apt system:

• apt_updates - the number of updates available on the system
• apt_security_updates - the number of updates which are security updates
• apt_package_updates - the package names that are available for update. On Facter 2.0 and newer this will be a list type, in earlier versions it is a comma delimitered string.

Hiera example

Testing

The APT module is mostly a collection of defined resource types, which provide reusable logic that can be leveraged to manage APT. It does provide smoke tests for testing functionality on a target system, as well as spec tests for checking a compiled catalog against an expected set of resources.

Example Test

This test will set up a Puppet Labs apt repository. Start by creating a new smoke test in the apt module's test folder. Call it puppetlabs-apt.pp. Inside, declare a single resource representing the Puppet Labs APT source and gpg key

apt::source { 'puppetlabs':
  location   => 'http://apt.puppetlabs.com',
  repos      => 'main',
  key        => '4BD6EC30',
  key_server => 'pgp.mit.edu',
}

This resource creates an apt source named puppetlabs and gives Puppet information about the repository's location and key used to sign its packages. Puppet leverages Facter to determine the appropriate release, but you can set it directly by adding the release type.

Check your smoke test for syntax errors

$ puppet parser validate tests/puppetlabs-apt.pp

If you receive no output from that command, it means nothing is wrong. Then apply the code

$ puppet apply --verbose tests/puppetlabs-apt.pp
notice: /Stage[main]//Apt::Source[puppetlabs]/File[puppetlabs.list]/ensure: defined content as '{md5}3be1da4923fb910f1102a233b77e982e'
info: /Stage[main]//Apt::Source[puppetlabs]/File[puppetlabs.list]: Scheduling refresh of Exec[puppetlabs apt update]
notice: /Stage[main]//Apt::Source[puppetlabs]/Exec[puppetlabs apt update]: Triggered 'refresh' from 1 events>

The above example used a smoke test to easily lay out a resource declaration and apply it on your system. In production, you may want to declare your APT sources inside the classes where they’re needed.

Implementation

apt::backports

Adds the necessary components to get backports for Ubuntu and Debian. The release name defaults to $lsbdistcodename. Setting this manually can cause undefined behavior (read: universe exploding).

By default this class drops a Pin-file for Backports pinning it to a priority of 200, lower than the normal Debian archive which gets a priority of 500 to ensure your packages with ensure => latest don't get magically upgraded from Backports without your explicit say-so.

If you raise the priority through the pin_priority parameter to 500, identical to the rest of the Debian mirrors, normal policy goes into effect and the newest version wins/becomes the candidate apt will want to install or upgrade to. This means that if a package is available from Backports it and its dependencies will be pulled in from Backports unless you explicitly set the ensure attribute of the package resource to installed/present or a specific version.

Limitations

This module should work across all versions of Debian/Ubuntu and support all major APT repository management features.

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.

You can read the complete module contribution guide on the Puppet Labs wiki.

License

The original code for this module comes from Evolving Web and was licensed under the MIT license. Code added since the fork of this module is licensed under the Apache 2.0 License like the rest of the Puppet Labs products.

The LICENSE contains both licenses.

Contributors

A lot of great people have contributed to this module. A somewhat current list follows:

• Ben Godfrey ben.godfrey@wonga.com
• Branan Purvine-Riley branan@puppetlabs.com
• Christian G. Warden cwarden@xerus.org
• Dan Bode bodepd@gmail.com dan@puppetlabs.com
• Daniel Tremblay github@danieltremblay.ca
• Garrett Honeycutt github@garretthoneycutt.com
• Jeff Wallace jeff@evolvingweb.ca jeff@tjwallace.ca
• Ken Barber ken@bob.sh
• Matthaus Litteken matthaus@puppetlabs.com mlitteken@gmail.com
• Matthias Pigulla mp@webfactory.de
• Monty Taylor mordred@inaugust.com
• Peter Drake pdrake@allplayers.com
• Reid Vandewiele marut@cat.pdx.edu
• Robert Navarro rnavarro@phiivo.com
• Ryan Coleman ryan@puppetlabs.com
• Scott McLeod scott.mcleod@theice.com
• Spencer Krum spencer@puppetlabs.com
• William Van Hevelingen blkperl@cat.pdx.edu wvan13@gmail.com
• Zach Leslie zach@puppetlabs.com
• Daniele Sluijters github@daenney.net
• Daniel Paulus daniel@inuits.eu

##2014-08-20 - Supported Release 1.6.0 ###Summary

####Features

• Allow URL or domain name for key_server parameter
• Allow custom comment for sources list
• Enable auto-update for Debian squeeze LTS
• Add facts showing available updates
• Test refactoring

####Bugfixes

• Allow dashes in URL or domain for key_server parameter

##2014-08-13 - Supported Release 1.5.3 ###Summary

This is a bugfix releases. It addresses a bad regex, failures with unicode characters, and issues with the $proxy_host handling in apt::ppa.

####Features

• Synced files from Modulesync

####Bugfixes

• Fix regex to follow APT requirements in apt::pin
• Fix for unicode characters
• Fix inconsistent $proxy_host handling in apt and apt::ppa
• Fix typo in README
• Fix broken acceptance tests

##2014-07-15 - Supported Release 1.5.2 ###Summary

This release merely updates metadata.json so the module can be uninstalled and upgraded via the puppet module command.

##2014-07-10 - Supported Release 1.5.1 ###Summary

This release has added tests to ensure graceful failure on OSX.

##2014-06-04 - Release 1.5.0 ###Summary

This release adds support for Ubuntu 14.04. It also includes many new features and important bugfixes. One huge change is that apt::key was replaced with apt_key, which allows you to use puppet resource apt_key to inventory keys on your system.

Special thanks to daenney, our intrepid unofficial apt maintainer!

####Features

• Add support for Ubuntu Trusty!
• Add apt::hold define
• Generate valid *.pref files in apt::pin
• Made pin_priority configurable for apt::backports
• Add apt_key type and provider
• Rename "${apt_conf_d}/proxy" to "${apt_conf_d}/01proxy"
• apt::key rewritten to use apt_key type
• Add support for update_tries to apt::update

####Bugfixes

• Typo fixes
• Fix unattended upgrades
• Removed bogus line when using purge_preferences
• Fix apt::force to upgrade allow packages to be upgraded to the pacakge from the specified release

##2014-03-04 - Supported Release 1.4.2 ###Summary

This is a supported release. This release tidies up 1.4.1 and re-enables support for Ubuntu 10.04

####Features

####Bugfixes

• Fix apt:ppa to include the -y Ubuntu 10.04 requires.
• Documentation changes.
• Test fixups.

####Known Bugs

• No known issues.

##2014-02-13 1.4.1 ###Summary This is a bugfix release.

####Bugfixes

• Fix apt::force unable to upgrade packages from releases other than its original
• Removed a few refeneces to aptitude instead of apt-get for portability
• Removed call to getparam() due to stdlib dependency
• Correct apt::source template when architecture is provided
• Retry package installs if apt is locked
• Use root to exec in apt::ppa
• Updated tests and converted acceptance tests to beaker

##2013-10-08 - Release 1.4.0

###Summary

Minor bugfix and allow the timeout to be adjusted.

####Features

• Add an updates_timeout to apt::params

####Bugfixes

• Ensure apt::ppa can read a ppa removed by hand.

##2013-10-08 - Release 1.3.0 ###Summary

This major feature in this release is the new apt::unattended_upgrades class, allowing you to handle Ubuntu's unattended feature. This allows you to select specific packages to automatically upgrade without any further user involvement.

In addition we extend our Wheezy support, add proxy support to apt:ppa and do various cleanups and tweaks.

####Features

• Add apt::unattended_upgrades support for Ubuntu.
• Add wheezy backports support.
• Use the geoDNS http.debian.net instead of the main debian ftp server.
• Add options parameter to apt::ppa in order to pass options to apt-add-repository command.
• Add proxy support for apt::ppa (uses proxy_host and proxy_port from apt).

####Bugfixes

• Fix regsubst() calls to quote single letters (for future parser).
• Fix lint warnings and other misc cleanup.

##2013-07-03 - Release 1.2.0

####Features

• Add geppetto .project natures
• Add GH auto-release
• Add apt::key::key_options parameter
• Add complex pin support using distribution properties for apt::pin via new properties:
  • apt::pin::codename
  • apt::pin::release_version
  • apt::pin::component
  • apt::pin::originator
  • apt::pin::label
• Add source architecture support to apt::source::architecture

####Bugfixes

• Use apt-get instead of aptitude in apt::force
• Update default backports location
• Add dependency for required packages before apt-get update

##2013-06-02 - Release 1.1.1 ###Summary

This is a bug fix release that resolves a number of issues:

• By changing template variable usage, we remove the deprecation warnings for Puppet 3.2.x
• Fixed proxy file removal, when proxy absent

Some documentation, style and whitespaces changes were also merged. This release also introduced proper rspec-puppet unit testing on Travis-CI to help reduce regression.

Thanks to all the community contributors below that made this patch possible.

Detail Changes

• fix minor comment type (Chris Rutter)
• whitespace fixes (Michael Moll)
• Update travis config file (William Van Hevelingen)
• Build all branches on travis (William Van Hevelingen)
• Standardize travis.yml on pattern introduced in stdlib (William Van Hevelingen)
• Updated content to conform to README best practices template (Lauren Rother)
• Fix apt::release example in readme (Brian Galey)
• add @ to variables in template (Peter Hoeg)
• Remove deprecation warnings for pin.pref.erb as well (Ken Barber)
• Update travis.yml to latest versions of puppet (Ken Barber)
• Fix proxy file removal (Scott Barber)
• Add spec test for removing proxy configuration (Dean Reilly)
• Fix apt::key listing longer than 8 chars (Benjamin Knofe)

Release 1.1.0

###Summary

This release includes Ubuntu 12.10 (Quantal) support for PPAs.

##2012-05-25 - Puppet Labs info@puppetlabs.com - Release 0.0.4 ###Summary

• Fix ppa list filename when there is a period in the PPA name
• Add .pref extension to apt preferences files
• Allow preferences to be purged
• Extend pin support

##2012-05-04 - Puppet Labs info@puppetlabs.com - Release 0.0.3 ###Summary

• only invoke apt-get update once
• only install python-software-properties if a ppa is added
• support 'ensure => absent' for all defined types
• add apt::conf
• add apt::backports
• fixed Modulefile for module tool dependency resolution
• configure proxy before doing apt-get update
• use apt-get update instead of aptitude for apt::ppa
• add support to pin release

##2012-03-26 - Puppet Labs info@puppetlabs.com - Release 0.0.2 ###Summary

• 41cedbb (#13261) Add real examples to smoke tests.
• d159a78 (#13261) Add key.pp smoke test
• 7116c7a (#13261) Replace foo source with puppetlabs source
• 1ead0bf Ignore pkg directory.
• 9c13872 (#13289) Fix some more style violations
• 0ea4ffa (#13289) Change test scaffolding to use a module & manifest dir fixture path
• a758247 (#13289) Clean up style violations and fix corresponding tests
• 99c3fd3 (#13289) Add puppet lint tests to Rakefile
• 5148cbf (#13125) Apt keys should be case insensitive
• b9607a4 Convert apt::key to use anchors

##2012-03-07 - Puppet Labs info@puppetlabs.com - Release 0.0.1 ###Summary

• d4fec56 Modify apt::source release parameter test
• 1132a07 (#12917) Add contributors to README
• 8cdaf85 (#12823) Add apt::key defined type and modify apt::source to use it
• 7c0d10b (#12809) $release should use $lsbdistcodename and fall back to manual input
• be2cc3e (#12522) Adjust spec test for splitting purge
• 7dc60ae (#12522) Split purge option to spare sources.list
• 9059c4e Fix source specs to test all key permutations
• 8acb202 Add test for python-software-properties package
• a4af11f Check if python-software-properties is defined before attempting to define it.
• 1dcbf3d Add tests for required_packages change
• f3735d2 Allow duplicate $required_packages
• 74c8371 (#12430) Add tests for changes to apt module
• 97ebb2d Test two sources with the same key
• 1160bcd (#12526) Add ability to reverse apt { disable_keys => true }
• 2842d73 Add Modulefile to puppet-apt
• c657742 Allow the use of the same key in multiple sources
• 8c27963 (#12522) Adding purge option to apt class
• 997c9fd (#12529) Add unit test for apt proxy settings
• 50f3cca (#12529) Add parameter to support setting a proxy for apt
• d522877 (#12094) Replace chained .with_* with a hash
• 8cf1bd0 (#12094) Remove deprecated spec.opts file
• 2d688f4 (#12094) Add rspec-puppet tests for apt
• 0fb5f78 (#12094) Replace name with path in file resources
• f759bc0 (#11953) Apt::force passes $version to aptitude
• f71db53 (#11413) Add spec test for apt::force to verify changes to unless
• 2f5d317 (#11413) Update dpkg query used by apt::force
• cf6caa1 (#10451) Add test coverage to apt::ppa
• 0dd697d include_src parameter in example; Whitespace cleanup
• b662eb8 fix typos in "repositories"
• 1be7457 Fix (#10451) - apt::ppa fails to "apt-get update" when new PPA source is added
• 864302a Set the pin priority before adding the source (Fix #10449)
• 1de4e0a Refactored as per mlitteken
• 1af9a13 Added some crazy bash madness to check if the ppa is installed already. Otherwise the manifest tries to add it on every run!
• 52ca73e (#8720) Replace Apt::Ppa with Apt::Builddep
• 5c05fa0 added builddep command.
• a11af50 added the ability to specify the content of a key
• c42db0f Fixes ppa test.
• 77d2b0d reformatted whitespace to match recommended style of 2 space indentation.
• 27ebdfc ignore swap files.
• 377d58a added smoke tests for module.
• 18f614b reformatted apt::ppa according to recommended style.
• d8a1e4e Created a params class to hold global data.
• 636ae85 Added two params for apt class
• 148fc73 Update LICENSE.
• ed2d19e Support ability to add more than one PPA
• 420d537 Add call to apt-update after add-apt-repository in apt::ppa
• 945be77 Add package definition for python-software-properties
• 71fc425 Abs paths for all commands
• 9d51cd1 Adding LICENSE
• 71796e3 Heading fix in README
• 87777d8 Typo in README
• f848bac First commit