6 1. [Module Description - What the module does and why it is useful](#module-description)
7 1. [Setup - The basics of getting started with apt](#setup)
8 * [What apt affects](#what-apt-affects)
9 * [Beginning with apt](#beginning-with-apt)
10 1. [Usage - Configuration options and additional functionality](#usage)
11 * [Add GPG keys](#add-gpg-keys)
12 * [Prioritize backports](#prioritize-backports)
13 * [Update the list of packages](#update-the-list-of-packages)
14 * [Pin a specific release](#pin-a-specific-release)
15 * [Add a Personal Package Archive repository](#add-a-personal-package-archive-repository)
16 * [Configure Apt from Hiera](#configure-apt-from-hiera)
17 * [Replace the default sources.list file](#replace-the-default-sourceslist-file)
18 1. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
19 1. [Limitations - OS compatibility, etc.](#limitations)
20 1. [Development - Guide for contributing to the module](#development)
24 The apt module lets you use Puppet to manage APT (Advanced Package Tool) sources, keys, and other configuration options.
26 APT 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.
28 **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.
34 * Your system's `preferences` file and `preferences.d` directory
35 * Your system's `sources.list` file and `sources.list.d` directory
39 **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`.
41 ### Beginning with apt
43 To use the apt module with default parameters, declare the `apt` class.
49 **Note:** The main `apt` class is required by all other classes, types, and defined types in this module. You must declare it whenever you use the module.
55 **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.
57 Declare the `apt::key` defined type:
60 apt::key { 'puppetlabs':
61 id => '6F6B15509CF8E59E6E469F327F438280EF8D349F',
62 server => 'pgp.mit.edu',
63 options => 'http-proxy="http://proxyuser:proxypass@example.org:3128"',
67 ### Prioritize backports
70 class { 'apt::backports':
75 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.
77 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.
79 ### Update the list of packages
81 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':
90 When `Exec['apt_update']` is triggered, it generates a `Notice` message. Because the default [logging level for agents](https://docs.puppet.com/puppet/latest/configuration.html#loglevel) is `notice`, this causes the repository update to appear in logs and agent reports. Some tools, such as [The Foreman](https://www.theforeman.org), report the update notice as a significant change. To eliminate these updates from reports, set the [loglevel](https://docs.puppet.com/puppet/latest/metaparameter.html#loglevel) metaparameter for `Exec['apt_update']` above the agent logging level:
101 ### Pin a specific release
104 apt::pin { 'karmic': priority => 700 }
105 apt::pin { 'karmic-updates': priority => 700 }
106 apt::pin { 'karmic-security': priority => 700 }
109 You can also specify more complex pins using distribution properties:
114 originator => 'Debian',
115 release_version => '3.0',
121 To pin multiple packages, pass them to the `packages` parameter as an array or a space-delimited string.
123 ### Add a Personal Package Archive (PPA) repository
126 apt::ppa { 'ppa:drizzle-developers/ppa': }
129 ### Add an Apt source to `/etc/apt/sources.list.d/`
132 apt::source { 'debian_unstable':
133 comment => 'This is the iWeb Debian unstable mirror',
134 location => 'http://debian.mirror.iweb.ca/debian/',
135 release => 'unstable',
136 repos => 'main contrib non-free',
139 'id' => 'A1BD8E9D78F7FE5C3E65D8AF8B48AD6246925553',
140 'server' => 'subkeys.pgp.net',
149 To use the Puppet Apt repository as a source:
152 apt::source { 'puppetlabs':
153 location => 'http://apt.puppetlabs.com',
156 'id' => '6F6B15509CF8E59E6E469F327F438280EF8D349F',
157 'server' => 'pgp.mit.edu',
162 ### Configure Apt from Hiera
164 Instead of specifying your sources directly as resources, you can instead just include the `apt` class, which will pick up the values automatically from hiera.
169 comment: 'This is the iWeb Debian unstable mirror'
170 location: 'http://debian.mirror.iweb.ca/debian/'
172 repos: 'main contrib non-free'
175 id: 'A1BD8E9D78F7FE5C3E65D8AF8B48AD6246925553'
176 server: 'subkeys.pgp.net'
182 location: 'http://apt.puppetlabs.com'
185 id: '6F6B15509CF8E59E6E469F327F438280EF8D349F'
186 server: 'pgp.mit.edu'
189 ### Replace the default `sources.list` file
191 The following example replaces the default `/etc/apt/sources.list`. Along with this code, be sure to use the `purge` parameter, or you might get duplicate source warnings when running Apt.
194 apt::source { "archive.ubuntu.com-${lsbdistcodename}":
195 location => 'http://archive.ubuntu.com/ubuntu',
196 key => '630239CC130E1A7FD81A27B140976EAF437D05B5',
197 repos => 'main universe multiverse restricted',
200 apt::source { "archive.ubuntu.com-${lsbdistcodename}-security":
201 location => 'http://archive.ubuntu.com/ubuntu',
202 key => '630239CC130E1A7FD81A27B140976EAF437D05B5',
203 repos => 'main universe multiverse restricted',
204 release => "${lsbdistcodename}-security"
207 apt::source { "archive.ubuntu.com-${lsbdistcodename}-updates":
208 location => 'http://archive.ubuntu.com/ubuntu',
209 key => '630239CC130E1A7FD81A27B140976EAF437D05B5',
210 repos => 'main universe multiverse restricted',
211 release => "${lsbdistcodename}-updates"
214 apt::source { "archive.ubuntu.com-${lsbdistcodename}-backports":
215 location => 'http://archive.ubuntu.com/ubuntu',
216 key => '630239CC130E1A7FD81A27B140976EAF437D05B5',
217 repos => 'main universe multiverse restricted',
218 release => "${lsbdistcodename}-backports"
222 ### Manage login configuration settings for an APT source or proxy in `/etc/apt/auth.conf`
224 Starting with APT version 1.5, you can define login configuration settings, such as
225 username and password, for APT sources or proxies that require authentication
226 in the `/etc/apt/auth.conf` file. This is preferable to embedding login
227 information directly in `source.list` entries, which are usually world-readable.
229 The `/etc/apt/auth.conf` file follows the format of netrc (used by ftp or
230 curl) and has restrictive file permissions. See [here](https://manpages.debian.org/testing/apt/apt_auth.conf.5.en.html) for details.
232 Use the optional `apt::auth_conf_entries` parameter to specify an array of hashes containing login configuration settings. These hashes may only contain the `machine`, `login` and `password` keys.
236 auth_conf_entries => [
238 'machine' => 'apt-proxy.example.net',
239 'login' => 'proxylogin',
240 'password' => 'proxypassword',
243 'machine' => 'apt.example.com/ubuntu',
245 'password' => 'supersecret',
255 * `apt_updates`: The number of installed packages with available updates from `upgrade`.
257 * `apt_dist_updates`: The number of installed packages with available updates from `dist-upgrade`.
259 * `apt_security_updates`: The number of installed packages with available security updates from `upgrade`.
261 * `apt_security_dist_updates`: The number of installed packages with available security updates from `dist-upgrade`.
263 * `apt_package_updates`: The names of all installed packages with available updates from `upgrade`. In Facter 2.0 and later this data is formatted as an array; in earlier versions it is a comma-delimited string.
265 * `apt_package_dist_updates`: The names of all installed packages with available updates from `dist-upgrade`. In Facter 2.0 and later this data is formatted as an array; in earlier versions it is a comma-delimited string.
267 * `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).
269 * `apt_reboot_required`: Determines if a reboot is necessary after updates have been installed.
273 See [REFERENCE.md](https://github.com/puppetlabs/puppetlabs-apt/blob/master/REFERENCE.md) for all other reference documentation.
277 This module is not designed to be split across [run stages](https://docs.puppetlabs.com/puppet/latest/reference/lang_run_stages.html).
279 For an extensive list of supported operating systems, see [metadata.json](https://github.com/puppetlabs/puppetlabs-apt/blob/master/metadata.json)
281 ### Adding new sources or PPAs
283 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']`, as well as depending on the `Apt::Source` or the `Apt::Ppa`. You can also add [collectors](https://docs.puppetlabs.com/puppet/latest/reference/lang_collectors.html) to ensure that all packages happen after `apt::update`, but this can lead to dependency cycles and has implications for [virtual resources](https://docs.puppetlabs.com/puppet/latest/reference/lang_collectors.html#behavior). Before running the command below, ensure that all packages have the provider set to apt.
286 Class['apt::update'] -> Package <| provider == 'apt' |>
291 Puppet 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.
293 For more information, see our [module contribution guide.](https://docs.puppetlabs.com/forge/contributing.html)
295 To see who's already involved, see the [list of contributors.](https://github.com/puppetlabs/puppetlabs-apt/graphs/contributors)