4 [![Build Status](https://travis-ci.org/puppetlabs/puppetlabs-apt.png?branch=master)](https://travis-ci.org/puppetlabs/puppetlabs-apt)
9 The APT module provides a simple interface for managing APT source, key, and definitions with Puppet.
14 APT automates obtaining and installing software packages on \*nix systems.
16 ***Note:** While this module allows the use of short keys, we STRONGLY RECOMMEND that you DO NOT USE short keys, as they pose a serious security issue in that they open you up to collision attacks.*
23 * package/service/configuration files for APT
24 * your system's `sources.list` file and `sources.list.d` directory
25 * 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'.
30 ### Beginning with APT
32 To begin using the APT module with default parameters, declare the class
36 Puppet code that uses anything from the APT module requires that the core apt class be declared/\s\+$//e
41 Using the APT module consists predominantly in declaring classes that provide desired functionality and features.
45 `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.
47 The parameters for `apt` are not required in general and are predominantly for development environment use-cases.
50 always_apt_update => false,
51 disable_keys => undef,
54 purge_sources_list => false,
55 purge_sources_list_d => false,
56 purge_preferences_d => false,
57 update_timeout => undef
60 Puppet will manage your system's `sources.list` file and `sources.list.d` directory but will do its best to respect existing content.
62 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.
66 Installs the build depends of a specified package.
68 apt::builddep { 'glusterfs-server': }
72 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.
74 apt::force { 'glusterfs-server':
75 release => 'unstable',
77 require => Apt::Source['debian_unstable'],
82 Adds a key to the list of keys used by APT to authenticate packages.
84 apt::key { 'puppetlabs':
86 key_server => 'pgp.mit.edu',
91 key_source => 'http://pkg.jenkins-ci.org/debian/jenkins-ci.org.key',
94 Note that use of `key_source` requires wget to be installed and working.
98 Adds an apt pin for a certain release.
100 apt::pin { 'karmic': priority => 700 }
101 apt::pin { 'karmic-updates': priority => 700 }
102 apt::pin { 'karmic-security': priority => 700 }
104 Note you can also specifying more complex pins using distribution properties.
108 originator => 'Debian',
109 release_version => '3.0',
116 Adds a ppa repository using `add-apt-repository`.
118 apt::ppa { 'ppa:drizzle-developers/ppa': }
122 Sets the default apt release. This class is particularly useful when using repositories, like Debian, that are unstable in Ubuntu.
124 class { 'apt::release':
125 release_id => 'precise',
130 Adds an apt source to `/etc/apt/sources.list.d/`.
132 apt::source { 'debian_unstable':
133 location => 'http://debian.mirror.iweb.ca/debian/',
134 release => 'unstable',
135 repos => 'main contrib non-free',
136 required_packages => 'debian-keyring debian-archive-keyring',
138 key_server => 'subkeys.pgp.net',
143 If you would like to configure your system so the source is the Puppet Labs APT repository
145 apt::source { 'puppetlabs':
146 location => 'http://apt.puppetlabs.com',
149 key_server => 'pgp.mit.edu',
154 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.
158 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
160 apt::source { 'puppetlabs':
161 location => 'http://apt.puppetlabs.com',
164 key_server => 'pgp.mit.edu',
167 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.
169 Check your smoke test for syntax errors
171 $ puppet parser validate tests/puppetlabs-apt.pp
173 If you receive no output from that command, it means nothing is wrong. Then apply the code
175 $ puppet apply --verbose tests/puppetlabs-apt.pp
176 notice: /Stage[main]//Apt::Source[puppetlabs]/File[puppetlabs.list]/ensure: defined content as '{md5}3be1da4923fb910f1102a233b77e982e'
177 info: /Stage[main]//Apt::Source[puppetlabs]/File[puppetlabs.list]: Scheduling refresh of Exec[puppetlabs apt update]
178 notice: /Stage[main]//Apt::Source[puppetlabs]/Exec[puppetlabs apt update]: Triggered 'refresh' from 1 events>
180 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.
187 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).
192 This module should work across all versions of Debian/Ubuntu and support all major APT repository management features.
197 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.
199 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.
201 You can read the complete module contribution guide [on the Puppet Labs wiki.](http://projects.puppetlabs.com/projects/module-site/wiki/Module_contributing)
206 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.
208 The LICENSE contains both licenses.
213 A lot of great people have contributed to this module. A somewhat current list follows:
215 * Ben Godfrey <ben.godfrey@wonga.com>
216 * Branan Purvine-Riley <branan@puppetlabs.com>
217 * Christian G. Warden <cwarden@xerus.org>
218 * Dan Bode <bodepd@gmail.com> <dan@puppetlabs.com>
219 * Garrett Honeycutt <github@garretthoneycutt.com>
220 * Jeff Wallace <jeff@evolvingweb.ca> <jeff@tjwallace.ca>
221 * Ken Barber <ken@bob.sh>
222 * Matthaus Litteken <matthaus@puppetlabs.com> <mlitteken@gmail.com>
223 * Matthias Pigulla <mp@webfactory.de>
224 * Monty Taylor <mordred@inaugust.com>
225 * Peter Drake <pdrake@allplayers.com>
226 * Reid Vandewiele <marut@cat.pdx.edu>
227 * Robert Navarro <rnavarro@phiivo.com>
228 * Ryan Coleman <ryan@puppetlabs.com>
229 * Scott McLeod <scott.mcleod@theice.com>
230 * Spencer Krum <spencer@puppetlabs.com>
231 * William Van Hevelingen <blkperl@cat.pdx.edu> <wvan13@gmail.com>
232 * Zach Leslie <zach@puppetlabs.com>