README.md

   1 apt
   2 ===
   3
   4 [![Build Status](https://travis-ci.org/puppetlabs/puppetlabs-apt.png?branch=master)](https://travis-ci.org/puppetlabs/puppetlabs-apt)
   5
   6 ## Description
   7
   8 Provides helpful definitions for dealing with Apt.
   9
  10 =======
  11
  12 Overview
  13 --------
  14
  15 The APT module provides a simple interface for managing APT source, key, and definitions with Puppet.
  16
  17 Module Description
  18 ------------------
  19
  20 APT automates obtaining and installing software packages on \*nix systems.
  21
  22 Setup
  23 -----
  24
  25 **What APT affects:**
  26
  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'.
  30 * system repositories
  31 * authentication keys
  32
  33 ### Beginning with APT
  34
  35 To begin using the APT module with default parameters, declare the class
  36
  37     include apt
  38
  39 Puppet code that uses anything from the APT module requires that the core apt class be declared/\s\+$//e
  40
  41 Usage
  42 -----
  43
  44 Using the APT module consists predominantly in declaring classes that provide desired functionality and features.
  45
  46 ### apt
  47
  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.
  49
  50 The parameters for `apt` are not required in general and are predominantly for development environment use-cases.
  51
  52     class { 'apt':
  53       always_apt_update    => false,
  54       disable_keys         => undef,
  55       proxy_host           => false,
  56       proxy_port           => '8080',
  57       purge_sources_list   => false,
  58       purge_sources_list_d => false,
  59       purge_preferences_d  => false,
  60       update_timeout       => undef
  61     }
  62
  63 Puppet will manage your system's `sources.list` file and `sources.list.d` directory but will do its best to respect existing content.
  64
  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.
  66
  67 ### apt::builddep
  68
  69 Installs the build depends of a specified package.
  70
  71     apt::builddep { 'glusterfs-server': }
  72
  73 ### apt::force
  74
  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.
  76
  77     apt::force { 'glusterfs-server':
  78       release => 'unstable',
  79       version => '3.0.3',
  80       require => Apt::Source['debian_unstable'],
  81     }
  82
  83 ### apt_key
  84
  85 A native Puppet type and provider for managing GPG keys for APT is provided by
  86 this module.
  87
  88     apt_key { 'puppetlabs':
  89       ensure => 'present',
  90       id     => '4BD6EC30',
  91     }
  92
  93 You can additionally set the following attributes:
  94
  95  * `source`: HTTP, HTTPS or FTP location of a GPG key or path to a file on the
  96              target host;
  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`.
 100
 101 Because it is a native type it can be used in and queried for with MCollective.
 102
 103 ### apt::key
 104
 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.
 108
 109     apt::key { 'puppetlabs':
 110       key        => '4BD6EC30',
 111       key_server => 'pgp.mit.edu',
 112     }
 113
 114     apt::key { 'jenkins':
 115       key        => 'D50582E6',
 116       key_source => 'http://pkg.jenkins-ci.org/debian/jenkins-ci.org.key',
 117     }
 118
 119 ### apt::pin
 120
 121 Adds an apt pin for a certain release.
 122
 123     apt::pin { 'karmic': priority => 700 }
 124     apt::pin { 'karmic-updates': priority => 700 }
 125     apt::pin { 'karmic-security': priority => 700 }
 126
 127 Note you can also specifying more complex pins using distribution properties.
 128
 129     apt::pin { 'stable':
 130       priority        => -10,
 131       originator      => 'Debian',
 132       release_version => '3.0',
 133       component       => 'main',
 134       label           => 'Debian'
 135     }
 136
 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
 139 names.
 140
 141 ### apt::hold
 142
 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'.
 147
 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`.
 152
 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
 158 should not allow it.
 159
 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'.
 165
 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:
 168
 169     apt::hold { 'vim':
 170       version => '2:7.3.547-7',
 171     }
 172
 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:
 175
 176     apt::hold { 'vim':
 177       version => '2:7.3.*',
 178     }
 179
 180 ### apt::ppa
 181
 182 Adds a ppa repository using `add-apt-repository`.
 183
 184     apt::ppa { 'ppa:drizzle-developers/ppa': }
 185
 186 ### apt::release
 187
 188 Sets the default apt release. This class is particularly useful when using repositories, like Debian, that are unstable in Ubuntu.
 189
 190     class { 'apt::release':
 191       release_id => 'precise',
 192     }
 193
 194 ### apt::source
 195
 196 Adds an apt source to `/etc/apt/sources.list.d/`.
 197
 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',
 203       key               => '46925553',
 204       key_server        => 'subkeys.pgp.net',
 205       pin               => '-10',
 206       include_src       => true
 207     }
 208
 209 If you would like to configure your system so the source is the Puppet Labs APT repository
 210
 211     apt::source { 'puppetlabs':
 212       location   => 'http://apt.puppetlabs.com',
 213       repos      => 'main',
 214       key        => '4BD6EC30',
 215       key_server => 'pgp.mit.edu',
 216     }
 217
 218
 219 #### Hiera example
 220 <pre>
 221 apt::sources:
 222   'debian_unstable':
 223       location: 'http://debian.mirror.iweb.ca/debian/'
 224       release: 'unstable'
 225       repos: 'main contrib non-free'
 226       required_packages: 'debian-keyring debian-archive-keyring'
 227       key: '55BE302B'
 228       key_server: 'subkeys.pgp.net'
 229       pin: '-10'
 230       include_src: 'true'
 231
 232   'puppetlabs':
 233       location: 'http://apt.puppetlabs.com'
 234       repos: 'main'
 235       key: '4BD6EC30'
 236       key_server: 'pgp.mit.edu'
 237 </pre>
 238
 239 ### Testing
 240
 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.
 242
 243 #### Example Test
 244
 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
 246
 247     apt::source { 'puppetlabs':
 248       location   => 'http://apt.puppetlabs.com',
 249       repos      => 'main',
 250       key        => '4BD6EC30',
 251       key_server => 'pgp.mit.edu',
 252     }
 253
 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.
 255
 256 Check your smoke test for syntax errors
 257
 258     $ puppet parser validate tests/puppetlabs-apt.pp
 259
 260 If you receive no output from that command, it means nothing is wrong. Then apply the code
 261
 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>
 266
 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.
 268
 269 Implementation
 270 --------------
 271
 272 ### apt::backports
 273
 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).
 275
 276 Limitations
 277 -----------
 278
 279 This module should work across all versions of Debian/Ubuntu and support all major APT repository management features.
 280
 281 Development
 282 ------------
 283
 284 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.
 285
 286 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.
 287
 288 You can read the complete module contribution guide [on the Puppet Labs wiki.](http://projects.puppetlabs.com/projects/module-site/wiki/Module_contributing)
 289
 290 License
 291 -------
 292
 293 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.
 294
 295 The LICENSE contains both licenses.
 296
 297 Contributors
 298 ------------
 299
 300 A lot of great people have contributed to this module. A somewhat current list follows:
 301
 302 * Ben Godfrey <ben.godfrey@wonga.com>
 303 * Branan Purvine-Riley <branan@puppetlabs.com>
 304 * Christian G. Warden <cwarden@xerus.org>
 305 * Dan Bode <bodepd@gmail.com> <dan@puppetlabs.com>
 306 * Daniel Tremblay <github@danieltremblay.ca>
 307 * Garrett Honeycutt <github@garretthoneycutt.com>
 308 * Jeff Wallace <jeff@evolvingweb.ca> <jeff@tjwallace.ca>
 309 * Ken Barber <ken@bob.sh>
 310 * Matthaus Litteken <matthaus@puppetlabs.com> <mlitteken@gmail.com>
 311 * Matthias Pigulla <mp@webfactory.de>
 312 * Monty Taylor <mordred@inaugust.com>
 313 * Peter Drake <pdrake@allplayers.com>
 314 * Reid Vandewiele <marut@cat.pdx.edu>
 315 * Robert Navarro <rnavarro@phiivo.com>
 316 * Ryan Coleman <ryan@puppetlabs.com>
 317 * Scott McLeod <scott.mcleod@theice.com>
 318 * Spencer Krum <spencer@puppetlabs.com>
 319 * William Van Hevelingen <blkperl@cat.pdx.edu> <wvan13@gmail.com>
 320 * Zach Leslie <zach@puppetlabs.com>
 321 * Daniele Sluijters <github@daenney.net>