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 Overview
   7 --------
   8
   9 The APT module provides a simple interface for managing APT source, key, and definitions with Puppet.
  10
  11 Module Description
  12 ------------------
  13
  14 APT automates obtaining and installing software packages on \*nix systems.
  15
  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.*
  17
  18 Setup
  19 -----
  20
  21 **What APT affects:**
  22
  23 * package/service/configuration files for APT
  24     * NOTE: Setting the `purge_preferences` or `purge_preferences_d` parameters to 'true' will destroy any existing configuration that was not declared with puppet. The default for these parameters is 'false'.
  25 * your system's `sources.list` file and `sources.list.d` directory
  26     * 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'.
  27 * system repositories
  28 * authentication keys
  29
  30 ### Beginning with APT
  31
  32 To begin using the APT module with default parameters, declare the class
  33
  34     include apt
  35
  36 Puppet code that uses anything from the APT module requires that the core apt class be declared/\s\+$//e
  37
  38 Usage
  39 -----
  40
  41 Using the APT module consists predominantly in declaring classes that provide desired functionality and features.
  42
  43 ### apt
  44
  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.
  46
  47 The parameters for `apt` are not required in general and are predominantly for development environment use-cases.
  48
  49     class { 'apt':
  50       always_apt_update    => false,
  51       disable_keys         => undef,
  52       proxy_host           => false,
  53       proxy_port           => '8080',
  54       purge_sources_list   => false,
  55       purge_sources_list_d => false,
  56       purge_preferences_d  => false,
  57       update_timeout       => undef,
  58       fancy_progress       => undef
  59     }
  60
  61 Puppet will manage your system's `sources.list` file and `sources.list.d` directory but will do its best to respect existing content.
  62
  63 If you declare your apt class with `purge_sources_list`, `purge_sources_list_d`, `purge_preferences` and `purge_preferences_d` set to 'true', Puppet will unapologetically purge any existing content it finds that wasn't declared with Puppet.
  64
  65 ### apt::builddep
  66
  67 Installs the build depends of a specified package.
  68
  69     apt::builddep { 'glusterfs-server': }
  70
  71 ### apt::force
  72
  73 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
  75     apt::force { 'glusterfs-server':
  76       release => 'unstable',
  77       version => '3.0.3',
  78       require => Apt::Source['debian_unstable'],
  79     }
  80
  81 ### apt_key
  82
  83 A native Puppet type and provider for managing GPG keys for APT is provided by
  84 this module.
  85
  86     apt_key { 'puppetlabs':
  87       ensure => 'present',
  88       id     => '4BD6EC30',
  89     }
  90
  91 You can additionally set the following attributes:
  92
  93  * `source`: HTTP, HTTPS or FTP location of a GPG key or path to a file on the
  94              target host;
  95  * `content`: Instead of pointing to a file, pass the key in as a string;
  96  * `server`: The GPG key server to use. It defaults to *keyserver.ubuntu.com*;
  97  * `keyserver_options`: Additional options to pass to `--keyserver`.
  98
  99 Because it is a native type it can be used in and queried for with MCollective.
 100
 101 ### apt::key
 102
 103 Adds a key to the list of keys used by APT to authenticate packages. This type
 104 uses the aforementioned `apt_key` native type. As such it no longer requires
 105 the wget command that the old implementation depended on.
 106
 107     apt::key { 'puppetlabs':
 108       key        => '4BD6EC30',
 109       key_server => 'pgp.mit.edu',
 110     }
 111
 112     apt::key { 'jenkins':
 113       key        => 'D50582E6',
 114       key_source => 'http://pkg.jenkins-ci.org/debian/jenkins-ci.org.key',
 115     }
 116
 117 ### apt::pin
 118
 119 Adds an apt pin for a certain release.
 120
 121     apt::pin { 'karmic': priority => 700 }
 122     apt::pin { 'karmic-updates': priority => 700 }
 123     apt::pin { 'karmic-security': priority => 700 }
 124
 125 Note you can also specifying more complex pins using distribution properties.
 126
 127     apt::pin { 'stable':
 128       priority        => -10,
 129       originator      => 'Debian',
 130       release_version => '3.0',
 131       component       => 'main',
 132       label           => 'Debian'
 133     }
 134
 135 If you wish to pin a number of packages you may specify the packages as a space
 136 delimited string using the `packages` attribute or pass in an array of package
 137 names.
 138
 139 ### apt::hold
 140
 141 When you wish to hold a package in Puppet is should be done by passing in
 142 'held' as the ensure attribute to the package resource. However, a lot of
 143 public modules do not take this into account and generally do not work well
 144 with an ensure of 'held'.
 145
 146 There is an additional issue that when Puppet is told to hold a package, it
 147 will hold it at the current version installed, there is no way to tell it in
 148 one go to install a specific version and then hold that version without using
 149 an exec resource that wraps `dpkg --set-selections` or `apt-mark`.
 150
 151 At first glance this could also be solved by just passing the version required
 152 to the ensure attribute but that only means that Puppet will install that
 153 version once it processes that package. It does not inform apt that we want
 154 this package to be held. In other words; if another package somehow wants to
 155 upgrade this one (because of a version requirement in a dependency), apt
 156 should not allow it.
 157
 158 In order to solve this you can use apt::hold. It's implemented by creating
 159 a preferences file with a priority of 1001, meaning that under normal
 160 circumstances this preference will always win. Because the priority is > 1000
 161 apt will interpret this as 'this should be the version installed and I am
 162 allowed to downgrade the current package if needed'.
 163
 164 With this you can now set a package's ensure attribute to 'latest' but still
 165 get the version specified by apt::hold. You can do it like this:
 166
 167     apt::hold { 'vim':
 168       version => '2:7.3.547-7',
 169     }
 170
 171 Since you might just want to hold Vim at version 7.3 and not care about the
 172 rest you can also pass in a version with a glob:
 173
 174     apt::hold { 'vim':
 175       version => '2:7.3.*',
 176     }
 177
 178 ### apt::ppa
 179
 180 Adds a ppa repository using `add-apt-repository`.
 181
 182     apt::ppa { 'ppa:drizzle-developers/ppa': }
 183
 184 ### apt::release
 185
 186 Sets the default apt release. This class is particularly useful when using repositories, like Debian, that are unstable in Ubuntu.
 187
 188     class { 'apt::release':
 189       release_id => 'precise',
 190     }
 191
 192 ### apt::source
 193
 194 Adds an apt source to `/etc/apt/sources.list.d/`.
 195
 196     apt::source { 'debian_unstable':
 197       comment           => 'This is the iWeb Debian unstable mirror',
 198       location          => 'http://debian.mirror.iweb.ca/debian/',
 199       release           => 'unstable',
 200       repos             => 'main contrib non-free',
 201       required_packages => 'debian-keyring debian-archive-keyring',
 202       key               => '46925553',
 203       key_server        => 'subkeys.pgp.net',
 204       pin               => '-10',
 205       include_src       => true
 206     }
 207
 208 If you would like to configure your system so the source is the Puppet Labs APT repository
 209
 210     apt::source { 'puppetlabs':
 211       location   => 'http://apt.puppetlabs.com',
 212       repos      => 'main',
 213       key        => '4BD6EC30',
 214       key_server => 'pgp.mit.edu',
 215     }
 216
 217 ### Facts
 218
 219 There are a few facts included within the apt module describing the state of the apt system:
 220
 221 * `apt_updates` - the number of updates available on the system
 222 * `apt_security_updates` - the number of updates which are security updates
 223 * `apt_package_updates` - the package names that are available for update. On Facter 2.0 and newer this will be a list type, in earlier versions it is a comma delimitered string.
 224
 225 #### Hiera example
 226 <pre>
 227 apt::sources:
 228   'debian_unstable':
 229       location: 'http://debian.mirror.iweb.ca/debian/'
 230       release: 'unstable'
 231       repos: 'main contrib non-free'
 232       required_packages: 'debian-keyring debian-archive-keyring'
 233       key: '55BE302B'
 234       key_server: 'subkeys.pgp.net'
 235       pin: '-10'
 236       include_src: 'true'
 237
 238   'puppetlabs':
 239       location: 'http://apt.puppetlabs.com'
 240       repos: 'main'
 241       key: '4BD6EC30'
 242       key_server: 'pgp.mit.edu'
 243 </pre>
 244
 245 ### Testing
 246
 247 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.
 248
 249 #### Example Test
 250
 251 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
 252
 253     apt::source { 'puppetlabs':
 254       location   => 'http://apt.puppetlabs.com',
 255       repos      => 'main',
 256       key        => '4BD6EC30',
 257       key_server => 'pgp.mit.edu',
 258     }
 259
 260 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.
 261
 262 Check your smoke test for syntax errors
 263
 264     $ puppet parser validate tests/puppetlabs-apt.pp
 265
 266 If you receive no output from that command, it means nothing is wrong. Then apply the code
 267
 268     $ puppet apply --verbose tests/puppetlabs-apt.pp
 269     notice: /Stage[main]//Apt::Source[puppetlabs]/File[puppetlabs.list]/ensure: defined content as '{md5}3be1da4923fb910f1102a233b77e982e'
 270     info: /Stage[main]//Apt::Source[puppetlabs]/File[puppetlabs.list]: Scheduling refresh of Exec[puppetlabs apt update]
 271     notice: /Stage[main]//Apt::Source[puppetlabs]/Exec[puppetlabs apt update]: Triggered 'refresh' from 1 events>
 272
 273 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.
 274
 275 Implementation
 276 --------------
 277
 278 ### apt::backports
 279
 280 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).
 281
 282 By default this class drops a Pin-file for Backports pinning it to a priority of 200, lower than the normal Debian archive which gets a priority of 500 to ensure your packages with `ensure => latest` don't get magically upgraded from Backports without your explicit say-so.
 283
 284 If you raise the priority through the `pin_priority` parameter to *500*, identical to the rest of the Debian mirrors, normal policy goes into effect and the newest version wins/becomes the candidate apt will want to install or upgrade to. This means that if a package is available from Backports it and its dependencies will be pulled in from Backports unless you explicitly set the `ensure` attribute of the `package` resource to `installed`/`present` or a specific version.
 285
 286 Limitations
 287 -----------
 288
 289 This module should work across all versions of Debian/Ubuntu and support all major APT repository management features.
 290
 291 Development
 292 ------------
 293
 294 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.
 295
 296 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.
 297
 298 You can read the complete module contribution guide [on the Puppet Labs wiki.](http://projects.puppetlabs.com/projects/module-site/wiki/Module_contributing)
 299
 300 License
 301 -------
 302
 303 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.
 304
 305 The LICENSE contains both licenses.
 306
 307 Contributors
 308 ------------
 309
 310 A lot of great people have contributed to this module. A somewhat current list follows:
 311
 312 * Ben Godfrey <ben.godfrey@wonga.com>
 313 * Branan Purvine-Riley <branan@puppetlabs.com>
 314 * Christian G. Warden <cwarden@xerus.org>
 315 * Dan Bode <bodepd@gmail.com> <dan@puppetlabs.com>
 316 * Daniel Tremblay <github@danieltremblay.ca>
 317 * Garrett Honeycutt <github@garretthoneycutt.com>
 318 * Jeff Wallace <jeff@evolvingweb.ca> <jeff@tjwallace.ca>
 319 * Ken Barber <ken@bob.sh>
 320 * Matthaus Litteken <matthaus@puppetlabs.com> <mlitteken@gmail.com>
 321 * Matthias Pigulla <mp@webfactory.de>
 322 * Monty Taylor <mordred@inaugust.com>
 323 * Peter Drake <pdrake@allplayers.com>
 324 * Reid Vandewiele <marut@cat.pdx.edu>
 325 * Robert Navarro <rnavarro@phiivo.com>
 326 * Ryan Coleman <ryan@puppetlabs.com>
 327 * Scott McLeod <scott.mcleod@theice.com>
 328 * Spencer Krum <spencer@puppetlabs.com>
 329 * William Van Hevelingen <blkperl@cat.pdx.edu> <wvan13@gmail.com>
 330 * Zach Leslie <zach@puppetlabs.com>
 331 * Daniele Sluijters <github@daenney.net>
 332 * Daniel Paulus <daniel@inuits.eu>