5 1. [Module Description - What the module does and why it is useful](#module-description)
6 1. [Setup - The basics of getting started with apt](#setup)
7 * [What apt affects](#what-apt-affects)
8 * [Beginning with apt](#beginning-with-apt)
9 1. [Usage - Configuration options and additional functionality](#usage)
10 * [Add GPG keys](#add-gpg-keys)
11 * [Prioritize backports](#prioritize-backports)
12 * [Update the list of packages](#update-the-list-of-packages)
13 * [Pin a specific release](#pin-a-specific-release)
14 * [Add a Personal Package Archive repository](#add-a-personal-package-archive-repository)
15 * [Configure Apt from Hiera](#configure-apt-from-hiera)
16 * [Replace the default sources.list file](#replace-the-default-sourceslist-file)
17 1. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
18 1. [Limitations - OS compatibility, etc.](#limitations)
19 1. [Development - Guide for contributing to the module](#development)
21 <a id="module-description"></a>
25 The apt module lets you use Puppet to manage APT (Advanced Package Tool) sources, keys, and other configuration options.
27 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.
29 **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.
35 <a id="what-apt-affects"></a>
39 * Your system's `preferences` file and `preferences.d` directory
40 * Your system's `sources.list` file and `sources.list.d` directory
41 * Your system's `apt.conf.d` directory
45 **Note:** This module offers `purge` parameters which, if set to `true`, **destroy** any configuration on the node's `sources.list(.d)`, `preferences(.d)` and `apt.conf.d` that you haven't declared through Puppet. The default for these parameters is `false`.
47 <a id="beginning-with-apt"></a>
49 ### Beginning with apt
51 To use the apt module with default parameters, declare the `apt` class.
57 **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.
63 <a id="add-gpg-keys"></a>
67 **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.
69 Declare the `apt::key` defined type:
72 apt::key { 'puppetlabs':
73 id => '6F6B15509CF8E59E6E469F327F438280EF8D349F',
74 server => 'pgp.mit.edu',
75 options => 'http-proxy="http://proxyuser:proxypass@example.org:3128"',
79 <a id="prioritize-backports"></a>
81 ### Prioritize backports
84 class { 'apt::backports':
89 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.
91 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.
93 <a id="update-the-list-of-packages"></a>
95 ### Update the list of packages
97 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':
102 frequency => 'daily',
107 When `Exec['apt_update']` is triggered, it generates a `notice`-level message. Because the default [logging level for agents](https://puppet.com/docs/puppet/latest/configuration.html#loglevel) is `notice`, this causes the repository update to appear in agent logs. To silence these updates from the default log output, set the [loglevel](https://puppet.com/docs/puppet/latest/metaparameter.html#loglevel) metaparameter for `Exec['apt_update']` above the agent logging level:
112 frequency => 'daily',
118 > **NOTE:** Every `Exec['apt_update']` run will generate a corrective change, even if the apt caches are not updated. For example, setting an update frequency of `always` can result in every Puppet run resulting in a corrective change. This is a known issue. For details, see [MODULES-10763](https://tickets.puppetlabs.com/browse/MODULES-10763).
120 <a id="pin-a-specific-release"></a>
122 ### Pin a specific release
125 apt::pin { 'karmic': priority => 700 }
126 apt::pin { 'karmic-updates': priority => 700 }
127 apt::pin { 'karmic-security': priority => 700 }
130 You can also specify more complex pins using distribution properties:
135 originator => 'Debian',
136 release_version => '3.0',
142 To pin multiple packages, pass them to the `packages` parameter as an array or a space-delimited string.
144 <a id="add-a-personal-package-archive-repository"></a>
146 ### Add a Personal Package Archive (PPA) repository
149 apt::ppa { 'ppa:drizzle-developers/ppa': }
152 ### Add an Apt source to `/etc/apt/sources.list.d/`
155 apt::source { 'debian_unstable':
156 comment => 'This is the iWeb Debian unstable mirror',
157 location => 'http://debian.mirror.iweb.ca/debian/',
158 release => 'unstable',
159 repos => 'main contrib non-free',
162 'id' => 'A1BD8E9D78F7FE5C3E65D8AF8B48AD6246925553',
163 'server' => 'subkeys.pgp.net',
172 To use the Puppet Apt repository as a source:
175 apt::source { 'puppetlabs':
176 location => 'http://apt.puppetlabs.com',
179 'id' => '6F6B15509CF8E59E6E469F327F438280EF8D349F',
180 'server' => 'pgp.mit.edu',
185 <a id="configure-apt-from-hiera"></a>
187 ### Configure Apt from Hiera
189 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.
194 comment: 'This is the iWeb Debian unstable mirror'
195 location: 'http://debian.mirror.iweb.ca/debian/'
197 repos: 'main contrib non-free'
200 id: 'A1BD8E9D78F7FE5C3E65D8AF8B48AD6246925553'
201 server: 'subkeys.pgp.net'
207 location: 'http://apt.puppetlabs.com'
210 id: '6F6B15509CF8E59E6E469F327F438280EF8D349F'
211 server: 'pgp.mit.edu'
214 <a id="replace-the-default-sourceslist-file"></a>
216 ### Replace the default `sources.list` file
218 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.
221 apt::source { "archive.ubuntu.com-${facts['os']['distro']['codename']}":
222 location => 'http://archive.ubuntu.com/ubuntu',
223 key => '630239CC130E1A7FD81A27B140976EAF437D05B5',
224 repos => 'main universe multiverse restricted',
227 apt::source { "archive.ubuntu.com-${facts['os']['distro']['codename']}-security":
228 location => 'http://archive.ubuntu.com/ubuntu',
229 key => '630239CC130E1A7FD81A27B140976EAF437D05B5',
230 repos => 'main universe multiverse restricted',
231 release => "${facts['os']['distro']['codename']}-security"
234 apt::source { "archive.ubuntu.com-${facts['os']['distro']['codename']}-updates":
235 location => 'http://archive.ubuntu.com/ubuntu',
236 key => '630239CC130E1A7FD81A27B140976EAF437D05B5',
237 repos => 'main universe multiverse restricted',
238 release => "${facts['os']['distro']['codename']}-updates"
241 apt::source { "archive.ubuntu.com-${facts['os']['distro']['codename']}-backports":
242 location => 'http://archive.ubuntu.com/ubuntu',
243 key => '630239CC130E1A7FD81A27B140976EAF437D05B5',
244 repos => 'main universe multiverse restricted',
245 release => "${facts['os']['distro']['codename']}-backports"
249 ### Manage login configuration settings for an APT source or proxy in `/etc/apt/auth.conf`
251 Starting with APT version 1.5, you can define login configuration settings, such as
252 username and password, for APT sources or proxies that require authentication
253 in the `/etc/apt/auth.conf` file. This is preferable to embedding login
254 information directly in `source.list` entries, which are usually world-readable.
256 The `/etc/apt/auth.conf` file follows the format of netrc (used by ftp or
257 curl) and has restrictive file permissions. See [here](https://manpages.debian.org/testing/apt/apt_auth.conf.5.en.html) for details.
259 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.
263 auth_conf_entries => [
265 'machine' => 'apt-proxy.example.net',
266 'login' => 'proxylogin',
267 'password' => 'proxypassword',
270 'machine' => 'apt.example.com/ubuntu',
272 'password' => 'supersecret',
278 <a id="reference"></a>
284 * `apt_updates`: The number of installed packages with available updates from `upgrade`.
286 * `apt_dist_updates`: The number of installed packages with available updates from `dist-upgrade`.
288 * `apt_security_updates`: The number of installed packages with available security updates from `upgrade`.
290 * `apt_security_dist_updates`: The number of installed packages with available security updates from `dist-upgrade`.
292 * `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.
294 * `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.
296 * `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).
298 * `apt_reboot_required`: Determines if a reboot is necessary after updates have been installed.
302 See [REFERENCE.md](https://github.com/puppetlabs/puppetlabs-apt/blob/main/REFERENCE.md) for all other reference documentation.
304 <a id="limitations"></a>
308 This module is not designed to be split across [run stages](https://docs.puppetlabs.com/puppet/latest/reference/lang_run_stages.html).
310 For an extensive list of supported operating systems, see [metadata.json](https://github.com/puppetlabs/puppetlabs-apt/blob/main/metadata.json)
312 ### Adding new sources or PPAs
314 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.
317 Class['apt::update'] -> Package <| provider == 'apt' |>
322 Acceptance tests for this module leverage [puppet_litmus](https://github.com/puppetlabs/puppet_litmus).
323 To run the acceptance tests follow the instructions [here](https://puppetlabs.github.io/litmus/Running-acceptance-tests.html).
324 You can also find a tutorial and walkthrough of using Litmus and the PDK on [YouTube](https://www.youtube.com/watch?v=FYfR7ZEGHoE).
326 If you run into an issue with this module, or if you would like to request a feature, please [file a ticket](https://tickets.puppetlabs.com/browse/MODULES/).
327 Every Monday the Puppet IA Content Team has [office hours](https://puppet.com/community/office-hours) in the [Puppet Community Slack](http://slack.puppet.com/), alternating between an EMEA friendly time (1300 UTC) and an Americas friendly time (0900 Pacific, 1700 UTC).
329 If you have problems getting this module up and running, please [contact Support](http://puppetlabs.com/services/customer-support).
331 If you submit a change to this module, be sure to regenerate the reference documentation as follows:
334 puppet strings generate --format markdown --out REFERENCE.md