7 The APT module provides a simple interface for managing APT source, key, and definitions with Puppet.
12 APT automates obtaining and installing software packages on *nix systems.
19 * package/service/configuration files for APT
20 * your system's `sources.list` file and `sources.list.d` directory
21 * 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'.
28 To begin using the APT module with default parameters, declare the class
32 Puppet code that uses anything from the APT module requires that the core apt class be declared.
37 Using the APT module consists predominantly in declaring classes that provide desired functionality and features.
41 `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.
43 The parameters for `apt` are not required in general and are predominantly for development environment use-cases.
46 always_apt_update => false,
47 disable_keys => undef,
50 purge_sources_list => false,
51 purge_sources_list_d => false,
52 purge_preferences_d => false
55 Puppet will manage your system's `sources.list` file and `sources.list.d` directory but will do its best to respect existing content.
57 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.
61 Installs the build depends of a specified package.
63 apt::builddep { 'glusterfs-server': }
67 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.
69 apt::force { 'glusterfs-server':
70 release => 'unstable',
72 require => Apt::Source['debian_unstable'],
77 Adds a key to the list of keys used by APT to authenticate packages.
79 apt::key { 'puppetlabs':
81 key_server => 'pgp.mit.edu',
86 key_source => 'http://pkg.jenkins-ci.org/debian/jenkins-ci.org.key',
89 Note that use of `key_source` requires wget to be installed and working.
93 Adds an apt pin for a certain release.
95 apt::pin { 'karmic': priority => 700 }
96 apt::pin { 'karmic-updates': priority => 700 }
97 apt::pin { 'karmic-security': priority => 700 }
101 Adds a ppa repository using `add-apt-repository`.
103 apt::ppa { 'ppa:drizzle-developers/ppa': }
107 Sets the default apt release. This class is particularly useful when using repositories, like Debian, that are unstable in Ubuntu.
109 apt::release { 'karmic': }
113 Adds an apt source to `/etc/apt/sources.list.d/`.
115 apt::source { 'debian_unstable':
116 location => 'http://debian.mirror.iweb.ca/debian/',
117 release => 'unstable',
118 repos => 'main contrib non-free',
119 required_packages => 'debian-keyring debian-archive-keyring',
121 key_server => 'subkeys.pgp.net',
126 If you would like to configure your system so the source is the Puppet Labs APT repository
128 apt::source { 'puppetlabs':
129 location => 'http://apt.puppetlabs.com',
132 key_server => 'pgp.mit.edu',
137 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.
141 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
143 apt::source { 'puppetlabs':
144 location => 'http://apt.puppetlabs.com',
147 key_server => 'pgp.mit.edu',
150 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.
152 Check your smoke test for syntax errors
154 $ puppet parser validate tests/puppetlabs-apt.pp
156 If you receive no output from that command, it means nothing is wrong. Then apply the code
158 $ puppet apply --verbose tests/puppetlabs-apt.pp
159 notice: /Stage[main]//Apt::Source[puppetlabs]/File[puppetlabs.list]/ensure: defined content as '{md5}3be1da4923fb910f1102a233b77e982e'
160 info: /Stage[main]//Apt::Source[puppetlabs]/File[puppetlabs.list]: Scheduling refresh of Exec[puppetlabs apt update]
161 notice: /Stage[main]//Apt::Source[puppetlabs]/Exec[puppetlabs apt update]: Triggered 'refresh' from 1 events>
163 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.
170 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).
175 This module should work across all versions of Debian/Ubuntu and support all major APT repository management features.
180 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.
182 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.
184 You can read the complete module contribution guide [on the Puppet Labs wiki.](http://projects.puppetlabs.com/projects/module-site/wiki/Module_contributing)
189 A lot of great people have contributed to this module. A somewhat current list follows:
191 * Ben Godfrey <ben.godfrey@wonga.com>
192 * Branan Purvine-Riley <branan@puppetlabs.com>
193 * Christian G. Warden <cwarden@xerus.org>
194 * Dan Bode <bodepd@gmail.com> <dan@puppetlabs.com>
195 * Garrett Honeycutt <github@garretthoneycutt.com>
196 * Jeff Wallace <jeff@evolvingweb.ca> <jeff@tjwallace.ca>
197 * Ken Barber <ken@bob.sh>
198 * Matthaus Litteken <matthaus@puppetlabs.com> <mlitteken@gmail.com>
199 * Matthias Pigulla <mp@webfactory.de>
200 * Monty Taylor <mordred@inaugust.com>
201 * Peter Drake <pdrake@allplayers.com>
202 * Reid Vandewiele <marut@cat.pdx.edu>
203 * Robert Navarro <rnavarro@phiivo.com>
204 * Ryan Coleman <ryan@puppetlabs.com>
205 * Scott McLeod <scott.mcleod@theice.com>
206 * Spencer Krum <spencer@puppetlabs.com>
207 * William Van Hevelingen <blkperl@cat.pdx.edu> <wvan13@gmail.com>
208 * Zach Leslie <zach@puppetlabs.com>
215 This release includes Ubuntu 12.10 (Quantal) support for PPAs.