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 The apt module 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 by opening 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.
  37
  38 Usage
  39 -----
  40
  41 Using the apt module consists predominantly of declaring classes that provide the 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 generally required 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 this module.
  84
  85     apt_key { 'puppetlabs':
  86       ensure => 'present',
  87       id     => '1054B7A24BD6EC30',
  88     }
  89
  90 You can additionally set the following attributes:
  91
  92  * `source`: HTTP, HTTPS or FTP location of a GPG key or path to a file on the
  93              target host;
  94  * `content`: Instead of pointing to a file, pass the key in as a string;
  95  * `server`: The GPG key server to use. It defaults to *keyserver.ubuntu.com*;
  96  * `keyserver_options`: Additional options to pass to `--keyserver`.
  97
  98 Because apt_key is a native type, it can be used in and queried for with MCollective.
  99
 100 ### apt::key
 101
 102 Adds a key to the list of keys used by APT to authenticate packages. This type uses the aforementioned `apt_key` native type. As such, it no longer requires
 103 the `wget` command on which the old implementation depended.
 104
 105     apt::key { 'puppetlabs':
 106       key        => '1054B7A24BD6EC30',
 107       key_server => 'pgp.mit.edu',
 108     }
 109
 110     apt::key { 'jenkins':
 111       key        => '9B7D32F2D50582E6',
 112       key_source => 'http://pkg.jenkins-ci.org/debian/jenkins-ci.org.key',
 113     }
 114
 115 ### apt::pin
 116
 117 Adds an apt pin for a certain release.
 118
 119     apt::pin { 'karmic': priority => 700 }
 120     apt::pin { 'karmic-updates': priority => 700 }
 121     apt::pin { 'karmic-security': priority => 700 }
 122
 123 Note you can also specifying more complex pins using distribution properties.
 124
 125     apt::pin { 'stable':
 126       priority        => -10,
 127       originator      => 'Debian',
 128       release_version => '3.0',
 129       component       => 'main',
 130       label           => 'Debian'
 131     }
 132
 133 If you wish to pin a number of packages you may specify the packages as a space
 134 delimited string using the `packages` attribute or pass in an array of package
 135 names.
 136
 137 ### apt::hold
 138
 139 When you wish to hold a package in Puppet, it should be done by passing in
 140 'held' as the ensure attribute to the package resource. However, a lot of
 141 public modules do not take this into account and generally do not work well
 142 with an ensure of 'held'.
 143
 144 Moreover, when Puppet is told to hold a package, it holds it at the current version installed; there is no way to tell it to both install a specific version **and** hold that version, unless you use an exec resource that wraps `dpkg --set-selections` or `apt-mark`.
 145
 146 At first glance, it seems this issue could also be solved by passing the version required to the ensure attribute---but that only means that Puppet will install that
 147 version after it processes the package. It does not inform apt that we want
 148 this package to be held; that is, should another package want to upgrade this one (because of a version requirement in a dependency, for example), we want apt to refuse.
 149
 150 To solve this issue, use apt::hold. Implement this by creating a preferences file with a priority of 1001. Under normal circumstances, this preference will always win. Because the priority is > 1000, apt will maintain the required version, downgrading the current package if necessary.
 151
 152 With this, you can now set a package's ensure attribute to 'latest' but get the version specified by apt::hold:
 153
 154     apt::hold { 'vim':
 155       version => '2:7.3.547-7',
 156     }
 157
 158 Alternatively, if you want to hold Vim at version 7.3.*, you can pass in a version with a glob:
 159
 160     apt::hold { 'vim':
 161       version => '2:7.3.*',
 162     }
 163
 164 ### apt::ppa
 165
 166 Adds a ppa repository using `add-apt-repository`.
 167
 168     apt::ppa { 'ppa:drizzle-developers/ppa': }
 169
 170 ### apt::release
 171
 172 Sets the default apt release. This class is particularly useful when using repositories, like Debian, that are unstable in Ubuntu.
 173
 174     class { 'apt::release':
 175       release_id => 'precise',
 176     }
 177
 178 ### apt::source
 179
 180 Adds an apt source to `/etc/apt/sources.list.d/`.
 181
 182     apt::source { 'debian_unstable':
 183       comment           => 'This is the iWeb Debian unstable mirror',
 184       location          => 'http://debian.mirror.iweb.ca/debian/',
 185       release           => 'unstable',
 186       repos             => 'main contrib non-free',
 187       required_packages => 'debian-keyring debian-archive-keyring',
 188       key               => '8B48AD6246925553',
 189       key_server        => 'subkeys.pgp.net',
 190       pin               => '-10',
 191       include_src       => true,
 192       include_deb       => true
 193     }
 194
 195 If you would like to configure your system so the source is the Puppet Labs APT repository:
 196
 197     apt::source { 'puppetlabs':
 198       location   => 'http://apt.puppetlabs.com',
 199       repos      => 'main',
 200       key        => '1054B7A24BD6EC30',
 201       key_server => 'pgp.mit.edu',
 202     }
 203
 204 ### apt::update
 205
 206 Runs `apt-get update`, updating the list of available packages and their versions without installing or upgrading any packages.
 207
 208 The update runs on the first Puppet run after you include the class, then whenever `notify  => Exec['apt_update']` occurs---this should happen when config files get updated or other relevant changes occur. If you set the `always_apt_update` parameter, the update will run on every Puppet run.
 209
 210 ### Facts
 211
 212 There are a few facts included in the apt module describing the state of the apt system:
 213
 214 * `apt_updates` --- the number of updates available on the system
 215 * `apt_security_updates` --- the number of updates which are security updates
 216 * `apt_package_updates` --- the package names that are available for update. In Facter 2.0 and later, this will be a list type; in earlier versions, it is a comma-delimited string.
 217
 218 #### Hiera example
 219 <pre>
 220 apt::sources:
 221   'debian_unstable':
 222       location: 'http://debian.mirror.iweb.ca/debian/'
 223       release: 'unstable'
 224       repos: 'main contrib non-free'
 225       required_packages: 'debian-keyring debian-archive-keyring'
 226       key: '9AA38DCD55BE302B'
 227       key_server: 'subkeys.pgp.net'
 228       pin: '-10'
 229       include_src: 'true'
 230       include_deb: 'true'
 231
 232   'puppetlabs':
 233       location: 'http://apt.puppetlabs.com'
 234       repos: 'main'
 235       key: '1054B7A24BD6EC30'
 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 provides 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, called puppetlabs-apt.pp, in the apt module's test folder. In this test, 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        => '1054B7A24BD6EC30',
 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 the key used to sign its packages. Puppet leverages Facter to determine the appropriate release, but you can set this 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 uses a smoke test to lay out a resource declaration and apply it on your system. In production, you might 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 By default this class drops a Pin-file for Backports, pinning it to a priority of 200. This is lower than the normal Debian archive, which gets a priority of 500 to ensure that packages with `ensure => latest` don't get magically upgraded from Backports without your explicit permission.
 277
 278 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.
 279
 280 Limitations
 281 -----------
 282
 283 This module should work across all versions of Debian/Ubuntu and support all major APT repository management features.
 284
 285 Development
 286 ------------
 287
 288 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.
 289
 290 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.
 291
 292 You can read the complete module contribution guide [on the Puppet Labs wiki.](http://projects.puppetlabs.com/projects/module-site/wiki/Module_contributing)
 293
 294 License
 295 -------
 296
 297 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.
 298
 299 The LICENSE contains both licenses.
 300
 301 Contributors
 302 ------------
 303
 304 A lot of great people have contributed to this module. A somewhat current list follows:
 305
 306 * Ben Godfrey <ben.godfrey@wonga.com>
 307 * Branan Purvine-Riley <branan@puppetlabs.com>
 308 * Christian G. Warden <cwarden@xerus.org>
 309 * Dan Bode <bodepd@gmail.com> <dan@puppetlabs.com>
 310 * Daniel Tremblay <github@danieltremblay.ca>
 311 * Garrett Honeycutt <github@garretthoneycutt.com>
 312 * Jeff Wallace <jeff@evolvingweb.ca> <jeff@tjwallace.ca>
 313 * Ken Barber <ken@bob.sh>
 314 * Matthaus Litteken <matthaus@puppetlabs.com> <mlitteken@gmail.com>
 315 * Matthias Pigulla <mp@webfactory.de>
 316 * Monty Taylor <mordred@inaugust.com>
 317 * Peter Drake <pdrake@allplayers.com>
 318 * Reid Vandewiele <marut@cat.pdx.edu>
 319 * Robert Navarro <rnavarro@phiivo.com>
 320 * Ryan Coleman <ryan@puppetlabs.com>
 321 * Scott McLeod <scott.mcleod@theice.com>
 322 * Spencer Krum <spencer@puppetlabs.com>
 323 * William Van Hevelingen <blkperl@cat.pdx.edu> <wvan13@gmail.com>
 324 * Zach Leslie <zach@puppetlabs.com>
 325 * Daniele Sluijters <github@daenney.net>
 326 * Daniel Paulus <daniel@inuits.eu>