Merge pull request #7 from cwarden/patch-1
[puppet-modules/puppetlabs-apt.git] / README.md
1 # Apt module for Puppet
2
3 ## Description
4 Provides helpful definitions for dealing with Apt.
5
6 ## Usage
7
8 ### apt:builddep
9 Install the build depends of a specified package.
10 <pre>
11 apt::builddep { "glusterfs-server": }
12 </pre>
13
14 ### apt::force
15 Force a package to be installed from a specific release.  Useful when using repositories like Debian unstable in Ubuntu.
16 <pre>
17 apt::force { "glusterfs-server":
18         release => "unstable",
19         version => '3.0.3',
20         require => Apt::Source["debian_unstable"],
21 }
22 </pre>
23
24 ### apt::pin
25 Add an apt pin for a certain release.
26 <pre>
27 apt::pin { "karmic": priority => 700 }
28 apt::pin { "karmic-updates": priority => 700 }
29 apt::pin { "karmic-security": priority => 700 }
30 </pre>
31
32 ### apt::ppa
33 Add a ppa repository using `add-apt-repository`.  Somewhat experimental.
34 <pre>
35 apt::ppa { "ppa:drizzle-developers/ppa": }
36 </pre>
37
38 ### apt::release
39 Set the default apt release.  Useful when using repositories like Debian unstable in Ubuntu.
40 <pre>
41 apt::release { "karmic": }
42 </pre>
43
44 ### apt::source
45 Add an apt source to `/etc/apt/sources.list.d/`.
46 <pre>
47 apt::source { "debian_unstable":
48         location => "http://debian.mirror.iweb.ca/debian/",
49         release => "unstable",
50         repos => "main contrib non-free",
51         required_packages => "debian-keyring debian-archive-keyring",
52         key => "55BE302B",
53         key_server => "subkeys.pgp.net",
54         pin => "-10"
55 }
56 </pre>