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'.
34 ### Beginning with APT
36 To begin using the APT module with default parameters, declare the class
40 Puppet code that uses anything from the APT module requires that the core apt class be declared.
45 Using the APT module consists predominantly in declaring classes that provide desired functionality and features.
49 `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.
51 The parameters for `apt` are not required in general and are predominantly for development environment use-cases.
54 always_apt_update => false,
55 disable_keys => undef,
58 purge_sources_list => false,
59 purge_sources_list_d => false,
60 purge_preferences_d => false,
61 update_timeout => undef
64 Puppet will manage your system's `sources.list` file and `sources.list.d` directory but will do its best to respect existing content.
66 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.
70 Installs the build depends of a specified package.
72 apt::builddep { 'glusterfs-server': }
76 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.
78 apt::force { 'glusterfs-server':
79 release => 'unstable',
81 require => Apt::Source['debian_unstable'],
86 Adds a key to the list of keys used by APT to authenticate packages.
88 apt::key { 'puppetlabs':
90 key_server => 'pgp.mit.edu',
95 key_source => 'http://pkg.jenkins-ci.org/debian/jenkins-ci.org.key',
98 Note that use of `key_source` requires wget to be installed and working.
102 Adds an apt pin for a certain release.
104 apt::pin { 'karmic': priority => 700 }
105 apt::pin { 'karmic-updates': priority => 700 }
106 apt::pin { 'karmic-security': priority => 700 }
108 Note you can also specifying more complex pins using distribution properties.
112 originator => 'Debian',
113 release_version => '3.0',
120 Adds a ppa repository using `add-apt-repository`.
122 apt::ppa { 'ppa:drizzle-developers/ppa': }
126 Sets the default apt release. This class is particularly useful when using repositories, like Debian, that are unstable in Ubuntu.
128 class { 'apt::release':
129 release_id => 'precise',
134 Adds an apt source to `/etc/apt/sources.list.d/`.
136 apt::source { 'debian_unstable':
137 location => 'http://debian.mirror.iweb.ca/debian/',
138 release => 'unstable',
139 repos => 'main contrib non-free',
140 required_packages => 'debian-keyring debian-archive-keyring',
142 key_server => 'subkeys.pgp.net',
147 If you would like to configure your system so the source is the Puppet Labs APT repository
149 apt::source { 'puppetlabs':
150 location => 'http://apt.puppetlabs.com',
153 key_server => 'pgp.mit.edu',
158 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.
162 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
164 apt::source { 'puppetlabs':
165 location => 'http://apt.puppetlabs.com',
168 key_server => 'pgp.mit.edu',
171 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.
173 Check your smoke test for syntax errors
175 $ puppet parser validate tests/puppetlabs-apt.pp
177 If you receive no output from that command, it means nothing is wrong. Then apply the code
179 $ puppet apply --verbose tests/puppetlabs-apt.pp
180 notice: /Stage[main]//Apt::Source[puppetlabs]/File[puppetlabs.list]/ensure: defined content as '{md5}3be1da4923fb910f1102a233b77e982e'
181 info: /Stage[main]//Apt::Source[puppetlabs]/File[puppetlabs.list]: Scheduling refresh of Exec[puppetlabs apt update]
182 notice: /Stage[main]//Apt::Source[puppetlabs]/Exec[puppetlabs apt update]: Triggered 'refresh' from 1 events>
184 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.
191 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).
196 This module should work across all versions of Debian/Ubuntu and support all major APT repository management features.
201 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.
203 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.
205 You can read the complete module contribution guide [on the Puppet Labs wiki.](http://projects.puppetlabs.com/projects/module-site/wiki/Module_contributing)
210 A lot of great people have contributed to this module. A somewhat current list follows:
212 * Ben Godfrey <ben.godfrey@wonga.com>
213 * Branan Purvine-Riley <branan@puppetlabs.com>
214 * Christian G. Warden <cwarden@xerus.org>
215 * Dan Bode <bodepd@gmail.com> <dan@puppetlabs.com>
216 * Garrett Honeycutt <github@garretthoneycutt.com>
217 * Jeff Wallace <jeff@evolvingweb.ca> <jeff@tjwallace.ca>
218 * Ken Barber <ken@bob.sh>
219 * Matthaus Litteken <matthaus@puppetlabs.com> <mlitteken@gmail.com>
220 * Matthias Pigulla <mp@webfactory.de>
221 * Monty Taylor <mordred@inaugust.com>
222 * Peter Drake <pdrake@allplayers.com>
223 * Reid Vandewiele <marut@cat.pdx.edu>
224 * Robert Navarro <rnavarro@phiivo.com>
225 * Ryan Coleman <ryan@puppetlabs.com>
226 * Scott McLeod <scott.mcleod@theice.com>
227 * Spencer Krum <spencer@puppetlabs.com>
228 * William Van Hevelingen <blkperl@cat.pdx.edu> <wvan13@gmail.com>
229 * Zach Leslie <zach@puppetlabs.com>