apt

{Build Status]

Overview

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

Module Description

The apt module automates obtaining and installing software packages on *nix systems.

Note: While this module allows the use of short keys, we urge you NOT to use short keys, as they pose a serious security issue by opening you up to collision attacks.

Setup

What apt affects:

Note: Setting the apt module's 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'.

Beginning with apt

To begin using the apt module with default parameters, declare the class with include apt.

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

Usage

Using the apt module consists predominantly of declaring classes and defined types that provide the desired functionality and features. This module provides common resources and options that are shared by the various defined types in the apt module, so you must always include this class in your manifests.

class { 'apt':
  always_apt_update    => false,
  apt_update_frequency => undef,
  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
}

Reference

Classes

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.

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

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 Apt installs or upgrades to the newest version. This means that if a package is available from backports, it and its dependencies are pulled in from backports unless you explicitly set the ensure attribute of the package resource to installed/present or a specific version.

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

apt::unattended_upgrades { origins = $::apt::params::origins, blacklist = [], update = '1', download = '1', upgrade = '1', autoclean = '7', }

Types

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

apt_key { 'puppetlabs': ensure => 'present', id => '1054B7A24BD6EC30', }

You can additionally set the following attributes:

Because apt_key is a native type, you can use it and query for it with MCollective.

Defined Types

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

To set a package's ensure attribute to 'latest' but get the version specified by apt::hold:

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

Alternatively, if you want to hold your package at a partial version, you can use a wildcard. For example, you can hold Vim at version 7.3.*:

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

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

Valid values for cfg_files are: * 'new': Overwrites all existing configuration files with newer ones. * 'old': Forces usage of all old files. * 'unchanged: Updates only unchanged config files. * 'none': Provides backward-compatibility with existing Puppet manifests.

Valid values for cfg_missing are 'true', 'false'. Setting this to 'false' provides backward compatability; setting it to 'true' checks for and installs missing configuration files for the selected package.

“` apt::key { 'puppetlabs': key => '1054B7A24BD6EC30', key_server => 'pgp.mit.edu', }

apt::key { 'jenkins': key => '9B7D32F2D50582E6', key_source => 'pkg.jenkins-ci.org/debian/jenkins-ci.org.key', } “`

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

Note that you can also specify more complex pins using distribution properties.

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

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

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 => '8B48AD6246925553', key_server => 'subkeys.pgp.net', pin => '-10', include_src => true, include_deb => true }

For example, to configure your system so the source is the Puppet Labs Apt repository:

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

Facts

The apt module includes a few facts to describe the state of the Apt system:

Note: The facts depend on 'update-notifier' being installed on your system. Though this is a GNOME daemon only the support files are needed so the package 'update-notifier-common' is enough to enable this functionality.

Hiera example

<pre>
apt::sources:
  'debian_unstable':
    location: 'http://debian.mirror.iweb.ca/debian/'
    release: 'unstable'
    repos: 'main contrib non-free'
    required_packages: 'debian-keyring debian-archive-keyring'
    key: '9AA38DCD55BE302B'
    key_server: 'subkeys.pgp.net'
    pin: '-10'
    include_src: 'true'
    include_deb: 'true'

  'puppetlabs':
    location: 'http://apt.puppetlabs.com'
    repos: 'main'
    key: '1054B7A24BD6EC30'
    key_server: 'pgp.mit.edu'
</pre>

Parameters

apt

apt::unattended_upgrades

Testing

The apt module is mostly a collection of defined resource types, which provide reusable logic for managing Apt. It provides 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 sets up a Puppet Labs Apt repository. Start by creating a new smoke test, called puppetlabs-apt.pp, in the apt module's test folder. In this test, declare a single resource representing the Puppet Labs Apt source and GPG key:

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

This resource creates an Apt source named puppetlabs and gives Puppet information about the repository's location and the key used to sign its packages. Puppet leverages Facter to determine the appropriate release, but you can set this 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 uses a smoke test to lay out a resource declaration and apply it on your system. In production, you might want to declare your Apt sources inside the classes where they’re needed.

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: