4 [![Build Status](https://travis-ci.org/puppetlabs/puppetlabs-apt.png?branch=master)](https://travis-ci.org/puppetlabs/puppetlabs-apt)
8 Provides helpful definitions for dealing with Apt.
15 The APT module provides a simple interface for managing APT source, key, and definitions with Puppet.
20 APT automates obtaining and installing software packages on \*nix systems.
27 * package/service/configuration files for APT
28 * your system's `sources.list` file and `sources.list.d` directory
29 * 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'.
33 ### Beginning with APT
35 To begin using the APT module with default parameters, declare the class
39 Puppet code that uses anything from the APT module requires that the core apt class be declared/\s\+$//e
44 Using the APT module consists predominantly in declaring classes that provide desired functionality and features.
48 `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.
50 The parameters for `apt` are not required in general and are predominantly for development environment use-cases.
53 always_apt_update => false,
54 disable_keys => undef,
57 purge_sources_list => false,
58 purge_sources_list_d => false,
59 purge_preferences_d => false,
60 update_timeout => undef
63 Puppet will manage your system's `sources.list` file and `sources.list.d` directory but will do its best to respect existing content.
65 If you declare your apt class with `purge_sources_list` and `purge_sources_list_d` set to 'true', Puppet will unapologetically purge any existing content it finds that wasn't declared with Puppet.
69 Installs the build depends of a specified package.
71 apt::builddep { 'glusterfs-server': }
75 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.
77 apt::force { 'glusterfs-server':
78 release => 'unstable',
80 require => Apt::Source['debian_unstable'],
85 A native Puppet type and provider for managing GPG keys for APT is provided by
88 apt_key { 'puppetlabs':
93 You can additionally set the following attributes:
95 * `source`: HTTP, HTTPS or FTP location of a GPG key or path to a file on the
97 * `content`: Instead of pointing to a file, pass the key in as a string;
98 * `server`: The GPG key server to use. It defaults to *keyserver.ubuntu.com*;
99 * `keyserver_options`: Additional options to pass to `--keyserver`.
101 Because it is a native type it can be used in and queried for with MCollective.
105 Adds a key to the list of keys used by APT to authenticate packages. This type
106 uses the aforementioned `apt_key` native type. As such it no longer requires
107 the wget command that the old implementation depended on.
109 apt::key { 'puppetlabs':
111 key_server => 'pgp.mit.edu',
114 apt::key { 'jenkins':
116 key_source => 'http://pkg.jenkins-ci.org/debian/jenkins-ci.org.key',
121 Adds an apt pin for a certain release.
123 apt::pin { 'karmic': priority => 700 }
124 apt::pin { 'karmic-updates': priority => 700 }
125 apt::pin { 'karmic-security': priority => 700 }
127 Note you can also specifying more complex pins using distribution properties.
131 originator => 'Debian',
132 release_version => '3.0',
137 If you wish to pin a number of packages you may specify the packages as a space
138 delimited string using the `packages` attribute or pass in an array of package
143 When you wish to hold a package in Puppet is should be done by passing in
144 'held' as the ensure attribute to the package resource. However, a lot of
145 public modules do not take this into account and generally do not work well
146 with an ensure of 'held'.
148 There is an additional issue that when Puppet is told to hold a package, it
149 will hold it at the current version installed, there is no way to tell it in
150 one go to install a specific version and then hold that version without using
151 an exec resource that wraps `dpkg --set-selections` or `apt-mark`.
153 At first glance this could also be solved by just passing the version required
154 to the ensure attribute but that only means that Puppet will install that
155 version once it processes that package. It does not inform apt that we want
156 this package to be held. In other words; if another package somehow wants to
157 upgrade this one (because of a version requirement in a dependency), apt
160 In order to solve this you can use apt::hold. It's implemented by creating
161 a preferences file with a priority of 1001, meaning that under normal
162 circumstances this preference will always win. Because the priority is > 1000
163 apt will interpret this as 'this should be the version installed and I am
164 allowed to downgrade the current package if needed'.
166 With this you can now set a package's ensure attribute to 'latest' but still
167 get the version specified by apt::hold. You can do it like this:
170 version => '2:7.3.547-7',
173 Since you might just want to hold Vim at version 7.3 and not care about the
174 rest you can also pass in a version with a glob:
177 version => '2:7.3.*',
182 Adds a ppa repository using `add-apt-repository`.
184 apt::ppa { 'ppa:drizzle-developers/ppa': }
188 Sets the default apt release. This class is particularly useful when using repositories, like Debian, that are unstable in Ubuntu.
190 class { 'apt::release':
191 release_id => 'precise',
196 Adds an apt source to `/etc/apt/sources.list.d/`.
198 apt::source { 'debian_unstable':
199 location => 'http://debian.mirror.iweb.ca/debian/',
200 release => 'unstable',
201 repos => 'main contrib non-free',
202 required_packages => 'debian-keyring debian-archive-keyring',
204 key_server => 'subkeys.pgp.net',
209 If you would like to configure your system so the source is the Puppet Labs APT repository
211 apt::source { 'puppetlabs':
212 location => 'http://apt.puppetlabs.com',
215 key_server => 'pgp.mit.edu',
223 location: 'http://debian.mirror.iweb.ca/debian/'
225 repos: 'main contrib non-free'
226 required_packages: 'debian-keyring debian-archive-keyring'
228 key_server: 'subkeys.pgp.net'
233 location: 'http://apt.puppetlabs.com'
236 key_server: 'pgp.mit.edu'
241 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.
245 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
247 apt::source { 'puppetlabs':
248 location => 'http://apt.puppetlabs.com',
251 key_server => 'pgp.mit.edu',
254 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.
256 Check your smoke test for syntax errors
258 $ puppet parser validate tests/puppetlabs-apt.pp
260 If you receive no output from that command, it means nothing is wrong. Then apply the code
262 $ puppet apply --verbose tests/puppetlabs-apt.pp
263 notice: /Stage[main]//Apt::Source[puppetlabs]/File[puppetlabs.list]/ensure: defined content as '{md5}3be1da4923fb910f1102a233b77e982e'
264 info: /Stage[main]//Apt::Source[puppetlabs]/File[puppetlabs.list]: Scheduling refresh of Exec[puppetlabs apt update]
265 notice: /Stage[main]//Apt::Source[puppetlabs]/Exec[puppetlabs apt update]: Triggered 'refresh' from 1 events>
267 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.
274 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).
276 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.
278 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.
283 This module should work across all versions of Debian/Ubuntu and support all major APT repository management features.
288 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.
290 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.
292 You can read the complete module contribution guide [on the Puppet Labs wiki.](http://projects.puppetlabs.com/projects/module-site/wiki/Module_contributing)
297 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.
299 The LICENSE contains both licenses.
304 A lot of great people have contributed to this module. A somewhat current list follows:
306 * Ben Godfrey <ben.godfrey@wonga.com>
307 * Branan Purvine-Riley <branan@puppetlabs.com>
308 * Christian G. Warden <cwarden@xerus.org>
309 * Dan Bode <bodepd@gmail.com> <dan@puppetlabs.com>
310 * Daniel Tremblay <github@danieltremblay.ca>
311 * Garrett Honeycutt <github@garretthoneycutt.com>
312 * Jeff Wallace <jeff@evolvingweb.ca> <jeff@tjwallace.ca>
313 * Ken Barber <ken@bob.sh>
314 * Matthaus Litteken <matthaus@puppetlabs.com> <mlitteken@gmail.com>
315 * Matthias Pigulla <mp@webfactory.de>
316 * Monty Taylor <mordred@inaugust.com>
317 * Peter Drake <pdrake@allplayers.com>
318 * Reid Vandewiele <marut@cat.pdx.edu>
319 * Robert Navarro <rnavarro@phiivo.com>
320 * Ryan Coleman <ryan@puppetlabs.com>
321 * Scott McLeod <scott.mcleod@theice.com>
322 * Spencer Krum <spencer@puppetlabs.com>
323 * William Van Hevelingen <blkperl@cat.pdx.edu> <wvan13@gmail.com>
324 * Zach Leslie <zach@puppetlabs.com>
325 * Daniele Sluijters <github@daenney.net>