apt

Table of Contents

1. Overview
2. Module Description - What the module does and why it is useful
3. Setup - The basics of getting started with apt
   • What apt affects
   • Beginning with apt
4. Usage - Configuration options and additional functionality
5. Reference - An under-the-hood peek at what the module is doing and how
   • Classes
   • Defines
   • Types
   • Facts
6. Limitations - OS compatibility, etc.
7. Development - Guide for contributing to the module

Overview

The apt module lets you use Puppet to manage Apt sources, keys, and other configuration options.

Module Description

Apt (Advanced Package Tool) is a package manager available on Debian, Ubuntu, and several other operating systems. The apt module provides a series of classes, defines, types, and facts to help you automate Apt package management.

Note: For this module to correctly autodetect which version of Debian/Ubuntu (or derivative) you're running, you need to make sure the 'lsb-release' package is installed. We highly recommend you either make this part of your provisioning layer, if you run many Debian or derivative systems, or ensure that you have Facter 2.2.0 or later installed, which will pull this dependency in for you.

Setup

What apt affects

• Your system's preferences file and preferences.d directory
• Your system's sources.list file and sources.list.d directory
• System repositories
• Authentication keys

Note: This module offers purge parameters which, if set to 'true', destroy any configuration on the node's sources.list(.d) and preferences(.d) that you haven't declared through Puppet. The default for these parameters is 'false'.

Beginning with apt

To use the apt module with default parameters, declare the apt class.

include apt

Note: The main apt class is required by all other classes, types, and defines in this module. You must declare it whenever you use the module.

Usage

Add GPG keys

Warning: Using short key IDs presents a serious security issue, potentially leaving you open to collision attacks. We recommend you always use full fingerprints to identify your GPG keys. This module allows short keys, but issues a security warning if you use them.

Declare the apt::key class:

apt::key { 'puppetlabs':
  id      => '47B320EB4C7C375AA9DAE1A01054B7A24BD6EC30',
  server  => 'pgp.mit.edu',
  options => 'http-proxy="http://proxyuser:proxypass@example.org:3128"',
}

Prioritize backports

class { 'apt::backports':
  pin => 500,
}

By default, the apt::backports class drops a pin file for backports, pinning it to a priority of 200. This is lower than the normal default of 500, so packages with ensure => latest don't get upgraded from backports without your explicit permission.

If you raise the priority through the pin parameter to 500, 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.

Update the list of packages

By default, Puppet runs apt-get update on the first Puppet run after you include the apt class, and anytime notify => Exec['apt_update'] occurs; i.e., whenever config files get updated or other relevant changes occur. If you set update['frequency'] to 'always', the update runs on every Puppet run. You can also set update['frequency'] to 'daily' or 'weekly':

class { 'apt':
  update => {
    frequency => 'daily',
  },
}

Pin a specific release

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

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'
}

To pin multiple packages, pass them to the packages parameter as an array or a space-delimited string.

Add a PPA (Personal Package Archive) repository

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

Add 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',
  pin      => '-10',
  key      => {
    'id'     => 'A1BD8E9D78F7FE5C3E65D8AF8B48AD6246925553',
    'server' => 'subkeys.pgp.net',
  },
  include  => {
    'src' => true,
    'deb' => true,
  },
}

To use the Puppet Labs Apt repository as a source:

apt::source { 'puppetlabs':
  location => 'http://apt.puppetlabs.com',
  repos    => 'main',
  key      => {
    'id'     => '47B320EB4C7C375AA9DAE1A01054B7A24BD6EC30',
    'server' => 'pgp.mit.edu',
  },
},

Configure Apt from Hiera

apt::sources:
  'debian_unstable':
    location: 'http://debian.mirror.iweb.ca/debian/'
    release: 'unstable'
    repos: 'main contrib non-free'
    key:
      id: '9AA38DCD55BE302B'
      server: 'subkeys.pgp.net'
    pin: '-10'
    include:
      src: true
      deb: true

  'puppetlabs':
    location: 'http://apt.puppetlabs.com'
    repos: 'main'
    key:
      id: '47B320EB4C7C375AA9DAE1A01054B7A24BD6EC30'
      server: 'pgp.mit.edu'

Reference

Classes

Public Classes

• apt
• apt::backports

Private Classes

• apt::params: Provides defaults for the apt module parameters.
• apt::update: Updates the list of available packages using apt-get update.

Defines

• apt::conf
• apt::key
• apt::pin
• apt::ppa
• apt::setting
• apt::source

Types

• apt_key

Facts

• apt_updates: The number of installed packages with available updates.

• apt_security_updates: The number of installed packages with available security updates.

• apt_package_updates: The names of all installed packages with available updates. In Facter 2.0 and later this data is formatted as an array; in earlier versions it is a comma-delimited string.

• apt_update_last_success: The date, in epochtime, of the most recent successful apt-get update run (based on the mtime of /var/lib/apt/periodic/update-success-stamp).

• apt_reboot_required: Determines if a reboot is necessary after updates have been installed.

Class: apt

Main class, includes all other classes.

Parameters (all optional)

• keys: Creates new apt::key resources. Valid options: a hash to be passed to the create_resources function. Default: {}.

• ppas: Creates new apt::ppa resources. Valid options: a hash to be passed to the create_resources function. Default: {}.

• proxy: Configures Apt to connect to a proxy server. Valid options: a hash made up from the following keys:

  • 'host': Specifies a proxy host to be stored in /etc/apt/apt.conf.d/01proxy. Valid options: a string containing a hostname. Default: undef.

  • 'port': Specifies a proxy port to be stored in /etc/apt/apt.conf.d/01proxy. Valid options: a string containing a port number. Default: '8080'.

  • 'https': Specifies whether to enable https proxies. Valid options: 'true' and 'false'. Default: 'false'.

  • 'ensure': Optional parameter. Valid options: 'file', 'present', and 'absent'. Default: 'undef'. Prefer 'file' over 'present'.

• purge: Specifies whether to purge any existing settings that aren't managed by Puppet. Valid options: a hash made up from the following keys:

  • 'sources.list': Specifies whether to purge any unmanaged entries from sources.list. Valid options: 'true' and 'false'. Default: 'false'.

  • 'sources.list.d': Specifies whether to purge any unmanaged entries from sources.list.d. Valid options: 'true' and 'false'. Default: 'false'.

  • 'preferences': Specifies whether to purge any unmanaged entries from preferences. Valid options: 'true' and 'false'. Default: 'false'.

  • 'preferences.d': Specifies whether to purge any unmanaged entries from preferences.d. Valid options: 'true' and 'false'. Default: 'false'.

• settings: Creates new apt::setting resources. Valid options: a hash to be passed to the create_resources function. Default: {}.

• sources: Creates new apt::source resources. Valid options: a hash to be passed to the create_resources function. Default: {}.

• pins: Creates new apt::pin resources. Valid options: a hash to be passed to the create_resources function. Default: {}.

• update: Configures various update settings. Valid options: a hash made up from the following keys:

  • 'frequency': Specifies how often to run apt-get update. If the exec resource apt_update is notified, apt-get update runs regardless of this value. Valid options: 'always' (at every Puppet run); 'daily' (if the value of apt_update_last_success is less than current epoch time minus 86400); 'weekly' (if the value of apt_update_last_success is less than current epoch time minus 604800); and 'reluctantly' (only if the exec resource apt_update is notified). Default: 'reluctantly'.

  • 'timeout': Specifies how long to wait for the update to complete before canceling it. Valid options: an integer, in seconds. Default: 300.

  • 'tries': Specifies how many times to retry the update after receiving a DNS or HTTP error. Valid options: an integer. Default: 1.

Class: apt::backports

Manages backports.

Parameters (all optional on Debian and Ubuntu; all required on other operating systems, except where specified)

• key: Specifies a key to authenticate the backports. Valid options: a string to be passed to the id parameter of the apt::key define, or a hash of parameter => value pairs to be passed to apt::key's id, server, content, source, and/or options parameters. Defaults:

  • Debian: 'A1BD8E9D78F7FE5C3E65D8AF8B48AD6246925553'
  • Ubuntu: '630239CC130E1A7FD81A27B140976EAF437D05B5'

• location: Specifies an Apt repository containing the backports to manage. Valid options: a string containing a URL. Defaults:

  • Debian (squeeze): 'http://httpredir.debian.org/debian-backports'
  • Debian (other): 'http://httpredir.debian.org/debian'
  • Ubuntu: 'http://archive.ubuntu.com/ubuntu'

• pin: Optional. Specifies a pin priority for the backports. Valid options: a number or string to be passed to the id parameter of the apt::pin define, or a hash of parameter => value pairs to be passed to apt::pin's corresponding parameters. Default: '200'.

• release: Specifies a distribution of the Apt repository containing the backports to manage. Valid options: a string containing the release, used in populating the source.list configuration file. Default: on Debian and Ubuntu, '${lsbdistcodename}-backports'. We recommend keeping this default, except on other operating systems.

• repos: Specifies a component of the Apt repository containing the backports to manage. Valid options: A string containing the repos to include, used in populating the source.list configuration file. Defaults:

  • Debian: 'main contrib non-free'
  • Ubuntu: 'main universe multiverse restricted'

Define: apt::conf

Specifies a custom Apt configuration file.

Parameters

• content: Required, unless ensure is set to 'absent'. Directly supplies content for the configuration file. Valid options: a string. Default: undef.

• ensure: Specifies whether the configuration file should exist. Valid options: 'present' and 'absent'. Default: 'present'.

• priority: Optional. Determines the order in which Apt processes the configuration file. Files with lower priority numbers are loaded first. Valid options: a string containing an integer. Default: '50'.

• notify_update: Optional. Specifies whether to trigger an apt-get update run. Valid options: 'true' and 'false'. Default: 'true'.

Define: apt::key

Manages the GPG keys that Apt uses to authenticate packages.

The apt::key define makes use of the apt_key type, but includes extra functionality to help prevent duplicate keys.

Parameters (all optional)

• content: Supplies the entire GPG key. Useful in case the key can't be fetched from a remote location and using a file resource is inconvenient. Valid options: a string. Default: undef.

• ensure: Specifies whether the key should exist. Valid options: 'present' and 'absent'. Default: 'present'.

• id: Specifies a GPG key to authenticate Apt package signatures. Valid options: a string containing a key ID (8 or 16 hexadecimal characters, optionally prefixed with "0x") or a full key fingerprint (40 hexadecimal characters). Default: $title.

• options: Passes additional options to apt-key adv --keyserver-options. Valid options: a string. Default: undef.

• source: Specifies the location of an existing GPG key file to copy. Valid options: a string containing a URL (ftp://, http://, or https://) or an absolute path. Default: undef.

• server: Specifies a keyserver to provide the GPG key. Valid options: a string containing a domain name or a full URL (http://, https://, or hkp://). Default: 'keyserver.ubuntu.com'.

• key: Specifies a GPG key to authenticate Apt package signatures. Valid options: a string containing a key ID (8 or 16 hexadecimal characters, optionally prefixed with "0x") or a full key fingerprint (40 hexadecimal characters). Default: undef. Note This parameter is deprecated and will be removed in a future release.

• key_content: Supplies the entire GPG key. Useful in case the key can't be fetched from a remote location and using a file resource is inconvenient. Valid options: a string. Default: undef. Note This parameter is deprecated and will be removed in a future release.

• key_source: Specifies the location of an existing GPG key file to copy. Valid options: a string containing a URL (ftp://, http://, or https://) or an absolute path. Default: undef. Note This parameter is deprecated and will be removed in a future release.

• key_server: Specifies a keyserver to provide the GPG key. Valid options: a string containing a domain name or a full URL (http://, https://, or hkp://). Default: 'keyserver.ubuntu.com'. Note This parameter is deprecated and will be removed in a future release.

• key_options: Passes additional options to apt-key adv --keyserver-options. Valid options: a string. Default: undef. Note This parameter is deprecated and will be removed in a future release.

Define: apt::pin

Manages Apt pins. Does not trigger an apt-get update run.

Note: For context on these parameters, we recommend reading the man page 'apt_preferences(5)'

Parameters (all optional)

• codename: Specifies the distribution (lsbdistcodename) of the Apt repository. Valid options: a string. Default: ''.

• component: Names the licensing component associated with the packages in the directory tree of the Release file. Valid options: a string. Default: ''.

• ensure: Specifies whether the pin should exist. Valid options: 'file', 'present', and 'absent'. Default: 'present'.

• explanation: Supplies a comment to explain the pin. Valid options: a string. Default: "${caller_module_name}: ${name}".

• label: Names the label of the packages in the directory tree of the Release file. Valid options: a string (most commonly, 'debian'). Default: ''.

• order: Determines the order in which Apt processes the pin file. Files with lower order numbers are loaded first. Valid options: an integer. Default: 50.

• origin: Tells Apt to prefer packages from the specified server. Valid options: a string containing a hostname. Default: ''.

• originator: Names the originator of the packages in the directory tree of the Release file. Valid options: a string (most commonly, 'debian'). Default: ''.

• packages: Specifies which package(s) to pin. Valid options: a string or an array. Default: '*'.

• priority: Sets the priority of the package. If multiple versions of a given package are available, apt-get installs the one with the highest priority number (subject to dependency constraints). Valid options: an integer. Default: 0.

• release: Tells Apt to prefer packages that support the specified release. Typical values include 'stable', 'testing', and 'unstable' Valid options: a string. Default: ''.

• release_version: Tells Apt to prefer packages that support the specified operating system release version (e.g., Debian release version 7). Valid options: a string. Default: ''.

• version: Tells Apt to prefer a specified package version or version range. Valid options: a string. Default: ''.

Define: apt::ppa

Manages PPA repositories using add-apt-repository. Not supported on Debian.

Parameters (all optional, except where specified)

• ensure: Specifies whether the PPA should exist. Valid options: 'present' and 'absent'. Default: 'present'.

• options: Supplies options to be passed to the add-apt-repository command. Valid options: a string. Defaults:

  • Lucid: undef
  • All others: '-y'

• package_manage: Specifies whether Puppet should manage the package that provides apt-add-repository. Valid options: 'true' and 'false'. Default: 'false'.

• package_name: Names the package that provides the apt-add-repository command. Valid options: a string. Defaults:

  • Lucid and Precise: 'python-software-properties'
  • Trusty, Utopic, and Vivid: 'software-properties-common'
  • All others: undef

• release: Optional if lsb-release is installed (unless you're using a different release than indicated by lsb-release, e.g., Linux Mint). Specifies the operating system of your node. Valid options: a string containing a valid LSB distribution codename. Default: "$lsbdistcodename".

Define: apt:setting

Manages Apt configuration files.

Parameters

• content: Required, unless source is set. Directly supplies content for the configuration file. Cannot be used in combination with source. Valid options: see the content attribute of Puppet's native file type. Default: undef.

• ensure: Specifies whether the file should exist. Valid options: 'present', 'absent', and 'file'. Default: 'file'.

• notify_update: Optional. Specifies whether to trigger an apt-get update run. Valid options: 'true' and 'false'. Default: 'true'.

• priority: Optional. Determines the order in which Apt processes the configuration file. Files with higher priority numbers are loaded first. Valid options: an integer or zero-padded integer. Default: 50.

• source: Required, unless content is set. Specifies a source file to supply the content of the configuration file. Cannot be used in combination with content. Valid options: see the source attribute of Puppet's native file type. Default: undef.

Define: apt::source

Manages the Apt sources in /etc/apt/sources.list.d/.

Parameters (all optional, except where specified)

• allow_unsigned: Specifies whether to authenticate packages from this release, even if the Release file is not signed or the signature can't be checked. Valid options: 'true' and 'false'. Default: 'false'.

• architecture: Tells Apt to only download information for specified architectures. Valid options: a string containing one or more architecture names, separated by commas (e.g., 'i386' or 'i386,alpha,powerpc'). Default: undef (if unspecified, Apt downloads information for all architectures defined in the Apt::Architectures option).

• comment: Supplies a comment for adding to the Apt source file. Valid options: a string. Default: $name.

• ensure: Specifies whether the Apt source file should exist. Valid options: 'present' and 'absent'. Default: 'present'.

• key: Creates a declaration of the apt::key define Valid options: a string to be passed to the id parameter of the apt::key define, or a hash of parameter => value pairs to be passed to apt::key's id, server, content, source, and/or options parameters. Default: undef.

• include: Configures include options. Valid options: a hash of available keys. Default: {}. Available keys are:

  • 'deb' - Specifies whether to request the distribution's compiled binaries. Valid options: 'true' and 'false'. Default: 'true'.

  • 'src' - Specifies whether to request the distribution's uncompiled source code. Valid options: 'true' and 'false'. Default: 'false'.

• location: Required, unless ensure is set to 'absent'. Specifies an Apt repository. Valid options: a string containing a repository URL. Default: undef.

• pin: Creates a declaration of the apt::pin define Valid options: a number or string to be passed to the id parameter of the apt::pin define, or a hash of parameter => value pairs to be passed to apt::pin's corresponding parameters. Default: undef.

• release: Specifies a distribution of the Apt repository. Valid options: a string. Default: "$lsbdistcodename".

  • repos: Specifies a component of the Apt repository. Valid options: a string. Default: 'main'.

• include_deb: Specify whether to request the distrubution's compiled binaries. Valid options: 'true' and 'false'. Default: undef. Note: This parameter is deprecated and will be removed in future versions of the module.

• include_src: Specifies whether to request the distribution's uncompiled source code. Valid options: 'true' and 'false'. Default: undef. Note: This parameter is deprecated and will be removed in future versions of the module.

• required_packages: Installs packages required for this Apt source via an exec. Default: 'false'. Note: This parameter is deprecated and will be removed in future versions of the module.

• key_content: Specifies the content to be passed to apt::key. Default: undef. Note: This parameter is deprecated and will be removed in future versions of the module.

• key_server: Specifies the server to be passed to apt::key. Default: undef. Note: This parameter is deprecated and will be removed in future versions of the module.

• key_source: Specifies the source to be passed to apt::key. Default: undef. Note: This parameter is deprecated and will be removed in future versions of the module.

• trusted_source: Specifies whether to authenticate packages from this release, even if the Release file is not signed or the signature can't be checked. Valid options: 'true' and 'false'. Default: undef. This parameter is deprecated and will be removed in a future version of the module.

Type: apt_key

Manages the GPG keys that Apt uses to authenticate packages.

Note: In most cases, we recommend using the apt::key define. It makes use of the apt_key type, but includes extra functionality to help prevent duplicate keys.

Parameters (all optional)

• content: Supplies the entire GPG key. Useful in case the key can't be fetched from a remote location and using a file resource is inconvenient. Cannot be used in combination with source. Valid options: a string. Default: undef.

• options: Passes additional options to apt-key adv --keyserver-options. Valid options: a string. Default: undef.

• server: Specifies a keyserver to provide Puppet's GPG key. Valid options: a string containing a domain name or a full URL. Default: 'keyserver.ubuntu.com'.

• source: Specifies the location of an existing GPG key file to copy. Cannot be used in combination with content. Valid options: a string containing a URL (ftp://, http://, or https://) or an absolute path. Default: undef.

Limitations

This module is tested and officially supported on Debian 6 and 7 and Ubuntu 10.04, 12.04, and 14.04. Testing on other platforms has been light and cannot be guaranteed.

Adding new sources or PPAs

If you are adding a new source or PPA and trying to install packages from the new source or PPA on the same Puppet run, your package resource should depend on Class['apt::update'], in addition to depending on the Apt::Source or the Apt::Ppa. You can also add collectors to ensure that all packages happen after apt::update, but this can lead to dependency cycles and has implications for virtual resources.

Class['apt::update'] -> Package<| |>

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 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.

For more information, see our module contribution guide.

To see who's already involved, see the list of contributors.

##2015-09-29 - Supported Release 2.2.0 ###Summary

This release includes a few bugfixes.

####Features

• Adds an ensure parameter for user control of proxy presence.
• Adds ability to set notify_update to apt::conf (MODULES-2269).
• Apt pins no longer trigger an apt-get update run.
• Adds support for creating pins from main class.

####Bugfixes

• Updates to use the official Debian mirrors.
• Fixes path to preferences and preferences.d
• Fixes pinning for backports (MODULES-2446).
• Fixes the name/extension of the preferences files.

##2015-07-28 - Supported Release 2.1.1 ###Summary

This release includes a few bugfixes.

####Bugfixes

• Fix incorrect use of anchoring (MODULES-2190)
• Use correct comment type for apt.conf files
• Test fixes
• Documentation fixes

##2015-06-16 - Supported Release 2.1.0 ###Summary

This release largely makes apt::key and apt::source API-compatible with the 1.8.x versions for ease in upgrading, and also addresses some compatibility issues with older versions of Puppet.

####Features

• Add API compatibility to apt::key and apt::source
• Added apt_reboot_required fact

####Bugfixes

• Fix compatibility with Puppet versions 3.0-3.4
• Work around future parser bug PUP-4133

##2015-04-28 - Supported Release 2.0.1 ###Summary

This bug fixes a few compatibility issues that came up with the 2.0.0 release, and includes test and documentation updates.

####Bugfixes

• Fix incompatibility with keyrings containing multiple keys
• Fix bugs preventing the module from working with Puppet < 3.5.0

##2015-04-07 - Supported Release 2.0.0 ###Summary

This is a major rewrite of the apt module. Many classes and defines were removed, but all existing functionality should still work. Please carefully review documentation before upgrading.

####Backwards-incompatible changes

As this is a major rewrite of the module there are a great number of backwards incompatible changes. Please review this and the updated README carefully before upgrading.

#####apt_key

• keyserver_options parameter renamed to options

#####apt::backports

• This no longer works out of the box on Linux Mint. If using this on mint, you must specify the location, release, repos, and key parameters. Example

#####apt::builddep

• This define was removed. Functionality can be matched passing 'build-dep' to install_options in the package resource. Example

#####apt::debian::testing

• This class was removed. Manually add an apt::source instead. Example

#####apt::debian::unstable

• This class was removed. Manually add an apt::source instead. Example

#####apt::force

• This define was removed. Functionallity can be matched by setting install_options in the package resource. See here for how to set the options.

#####apt::hold

• This define was removed. Simply use an apt::pin with priority => 1001 for the same functionality.

#####apt

• always_apt_update - This parameter was removed. Use update => { 'frequency' => 'always' } instead.
• apt_update_frequency - This parameter was removed. Use update => { 'frequency' => <frequency> } instead.
• disable_keys - This parameter was removed. See this example if you need this functionality.
• proxy_host - This parameter was removed. Use proxy => { 'host' => <host> } instead.
• proxy_port - This parameter was removed. Use proxy => { 'port' => <port> } instead.
• purge_sources_list - This parameter was removed. Use purge => { 'sources.list' => <bool> } instead.
• purge_sources_list_d - This parameter was removed. Use purge => { 'sources.list.d' => <bool> } instead.
• purge_preferences - This parameter was removed. Use purge => { 'preferences' => <bool> } instead.
• purge_preferences_d - This parameter was removed. Use purge => { 'preferences.d' => <bool> } instead.
• update_timeout - This parameter was removed. Use update => { 'timeout' => <timeout> } instead.
• update_tries - This parameter was removed. Use update => { 'tries' => <tries> } instead.

#####apt::key

• key - This parameter was renamed to id.
• key_content - This parameter was renamed to content.
• key_source - This parameter was renamed to source.
• key_server - This parameter was renamed to server.
• key_options - This parameter was renamed to options.

#####apt::release

• This class was removed. See this example for how to achieve this functionality.

#####apt::source

• include_src - This parameter was removed. Use include => { 'src' => <bool> } instead. NOTE This now defaults to false.
• include_deb - This parameter was removed. Use include => { 'deb' => <bool> } instead.
• required_packages - This parameter was removed. Use package resources for these packages if needed.
• key - This can either be a key id or a hash including key options. If using a hash, key => { 'id' => <id> } must be specified.
• key_server - This parameter was removed. Use key => { 'server' => <server> } instead.
• key_content - This parameter was removed. Use key => { 'content' => <content> } instead.
• key_source - This parameter was removed. Use key => { 'source' => <source> } instead.
• trusted_source - This parameter was renamed to allow_unsigned.

#####apt::unattended_upgrades

• This class was removed and is being republished under the puppet-community namespace. The git repository is available here and it will be published to the forge here.

####Changes to default behavior

• By default purge unmanaged files in 'sources.list', 'sources.list.d', 'preferences', and 'preferences.d'.
• Changed default for package_manage in apt::ppa to false. Set to true in a single PPA if you need the package to be managed.
• apt::source will no longer include the src entries by default.
• pin in apt::source now defaults to undef instead of false

####Features

• Added the ability to pass hashes of apt::keys, apt::ppas, and apt::settings to apt.
• Added 'https' key to proxy hash to allow disabling https_proxy for the apt::ppa environment.
• Added apt::setting define to abstract away configuration.
• Added the ability to pass hashes to pin and key in apt::backports and apt::source.

####Bugfixes

• Fixes for strict variables.

##2015-03-17 - Supported Release 1.8.0 ###Summary

This is the last planned feature release of the 1.x series of this module. All new features will be evaluated for puppetlabs-apt 2.x.

This release includes many important features, including support for full fingerprints, and fixes issues where apt_key was not supporting user/password and apt_has_updates was not properly parsing the apt-check output.

####Changes to default behavior

• The apt module will now throw warnings if you don't use full fingerprints for apt_keys

####Features

• Use gpg to check keys to work around https://bugs.launchpad.net/ubuntu/+source/gnupg2/+bug/1409117 (MODULES-1675)
• Add 'oldstable' to the default update origins for wheezy
• Add utopic, vivid, and cumulus compatibility
• Add support for full fingerprints
• New parameter for apt::source
  • trusted_source
• New parameters for apt::ppa
  • package_name
  • package_manage
• New parameter for apt::unattended_upgrades
  • legacy_origin
• Separate apt::pin from apt::backports to allow pin by release instead of origin

####Bugfixes

• Cleanup lint and future parser issues
• Fix to support username and passwords again for apt_key (MODULES-1119)
• Fix issue where apt::force $install_check didn't work with non-English locales (MODULES-1231)
• Allow 5 digit ports in apt_key
• Fix for ensure => absent in apt_key (MODULES-1661)
• Fix apt_has_updates not parsing apt-check output correctly
• Fix inconsistent headers across files (MODULES-1200)
• Clean up formatting for 50unattended-upgrades.erb

##2014-10-28 - Supported Release 1.7.0 ###Summary

This release includes several new features, documentation and test improvements, and a few bug fixes.

####Features

• Updated unit and acceptance tests
• Update module to work with Linux Mint
• Documentation updates
• Future parser / strict variables support
• Improved support for long GPG keys
• New parameters!
  • Added apt_update_frequency to apt
  • Added cfg_files and cfg_missing parameters to apt::force
  • Added randomsleep to apt::unattended_upgrades
• Added apt_update_last_success fact
• Refactored facts for performance improvements

####Bugfixes

• Update apt::builddep to require Exec['apt_update'] instead of notifying it
• Clean up lint errors

##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