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 The cfg_files parameter controls wether newer or older configuration files should be used or only unchanged configuration files should be updated. Cfg_missing forces the provider to install all missing configuration files. Both are optional.
  75
  76     apt::force { 'glusterfs-server':
  77       release     => 'unstable',
  78       version     => '3.0.3',
  79       cfg_files   => 'unchanged',
  80       cfg_missing => true,
  81       require     => Apt::Source['debian_unstable'],
  82     }
  83
  84 You can additionally set the following attributes:
  85
  86  * `cfg_files`: "new", "old", "unchanged" or "none" (default). "new" will overwrite all existing configuration files with newer ones, "old" will force usage of all old files and "unchanged" only updates unchanged config files whereas setting "none" will don't do anything but providing backward-compatability with existing puppet manifests.
  87  * `cfg_missing`: "true" or "false". Setting cfg_missing to false will provide backward compatability whereas setting true will add an aptitude/apt-get parameter which checks and installs missing configuration files for the selected package.
  88
  89 ### apt_key
  90
  91 A native Puppet type and provider for managing GPG keys for APT is provided by this module.
  92
  93     apt_key { 'puppetlabs':
  94       ensure => 'present',
  95       id     => '1054B7A24BD6EC30',
  96     }
  97
  98 You can additionally set the following attributes:
  99
 100  * `source`: HTTP, HTTPS or FTP location of a GPG key or path to a file on the
 101              target host;
 102  * `content`: Instead of pointing to a file, pass the key in as a string;
 103  * `server`: The GPG key server to use. It defaults to *keyserver.ubuntu.com*;
 104  * `keyserver_options`: Additional options to pass to `--keyserver`.
 105
 106 Because apt_key is a native type, it can be used in and queried for with MCollective.
 107
 108 ### apt::key
 109
 110 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
 111 the `wget` command on which the old implementation depended.
 112
 113     apt::key { 'puppetlabs':
 114       key        => '1054B7A24BD6EC30',
 115       key_server => 'pgp.mit.edu',
 116     }
 117
 118     apt::key { 'jenkins':
 119       key        => '9B7D32F2D50582E6',
 120       key_source => 'http://pkg.jenkins-ci.org/debian/jenkins-ci.org.key',
 121     }
 122
 123 ### apt::pin
 124
 125 Adds an apt pin for a certain release.
 126
 127     apt::pin { 'karmic': priority => 700 }
 128     apt::pin { 'karmic-updates': priority => 700 }
 129     apt::pin { 'karmic-security': priority => 700 }
 130
 131 Note you can also specifying more complex pins using distribution properties.
 132
 133     apt::pin { 'stable':
 134       priority        => -10,
 135       originator      => 'Debian',
 136       release_version => '3.0',
 137       component       => 'main',
 138       label           => 'Debian'
 139     }
 140
 141 If you wish to pin a number of packages you may specify the packages as a space
 142 delimited string using the `packages` attribute or pass in an array of package
 143 names.
 144
 145 ### apt::hold
 146
 147 When you wish to hold a package in Puppet, it should be done by passing in
 148 'held' as the ensure attribute to the package resource. However, a lot of
 149 public modules do not take this into account and generally do not work well
 150 with an ensure of 'held'.
 151
 152 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`.
 153
 154 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
 155 version after it processes the package. It does not inform apt that we want
 156 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.
 157
 158 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.
 159
 160 With this, you can now set a package's ensure attribute to 'latest' but get the version specified by apt::hold:
 161
 162     apt::hold { 'vim':
 163       version => '2:7.3.547-7',
 164     }
 165
 166 Alternatively, if you want to hold Vim at version 7.3.*, you can pass in a version with a glob:
 167
 168     apt::hold { 'vim':
 169       version => '2:7.3.*',
 170     }
 171
 172 ### apt::ppa
 173
 174 Adds a ppa repository using `add-apt-repository`.
 175
 176     apt::ppa { 'ppa:drizzle-developers/ppa': }
 177
 178 ### apt::release
 179
 180 Sets the default apt release. This class is particularly useful when using repositories, like Debian, that are unstable in Ubuntu.
 181
 182     class { 'apt::release':
 183       release_id => 'precise',
 184     }
 185
 186 ### apt::source
 187
 188 Adds an apt source to `/etc/apt/sources.list.d/`.
 189
 190     apt::source { 'debian_unstable':
 191       comment           => 'This is the iWeb Debian unstable mirror',
 192       location          => 'http://debian.mirror.iweb.ca/debian/',
 193       release           => 'unstable',
 194       repos             => 'main contrib non-free',
 195       required_packages => 'debian-keyring debian-archive-keyring',
 196       key               => '8B48AD6246925553',
 197       key_server        => 'subkeys.pgp.net',
 198       pin               => '-10',
 199       include_src       => true,
 200       include_deb       => true
 201     }
 202
 203 If you would like to configure your system so the source is the Puppet Labs APT repository:
 204
 205     apt::source { 'puppetlabs':
 206       location   => 'http://apt.puppetlabs.com',
 207       repos      => 'main',
 208       key        => '1054B7A24BD6EC30',
 209       key_server => 'pgp.mit.edu',
 210     }
 211
 212 ### apt::update
 213
 214 Runs `apt-get update`, updating the list of available packages and their versions without installing or upgrading any packages.
 215
 216 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.
 217
 218 ### Facts
 219
 220 There are a few facts included in the apt module describing the state of the apt system:
 221
 222 * `apt_updates` --- the number of updates available on the system
 223 * `apt_security_updates` --- the number of updates which are security updates
 224 * `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.
 225
 226 #### Hiera example
 227 <pre>
 228 apt::sources:
 229   'debian_unstable':
 230       location: 'http://debian.mirror.iweb.ca/debian/'
 231       release: 'unstable'
 232       repos: 'main contrib non-free'
 233       required_packages: 'debian-keyring debian-archive-keyring'
 234       key: '9AA38DCD55BE302B'
 235       key_server: 'subkeys.pgp.net'
 236       pin: '-10'
 237       include_src: 'true'
 238       include_deb: 'true'
 239
 240   'puppetlabs':
 241       location: 'http://apt.puppetlabs.com'
 242       repos: 'main'
 243       key: '1054B7A24BD6EC30'
 244       key_server: 'pgp.mit.edu'
 245 </pre>
 246
 247 ### Testing
 248
 249 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.
 250
 251 #### Example Test
 252
 253 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:
 254
 255     apt::source { 'puppetlabs':
 256       location   => 'http://apt.puppetlabs.com',
 257       repos      => 'main',
 258       key        => '1054B7A24BD6EC30',
 259       key_server => 'pgp.mit.edu',
 260     }
 261
 262 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.
 263
 264 Check your smoke test for syntax errors:
 265
 266     $ puppet parser validate tests/puppetlabs-apt.pp
 267
 268 If you receive no output from that command, it means nothing is wrong. Then, apply the code:
 269
 270     $ puppet apply --verbose tests/puppetlabs-apt.pp
 271     notice: /Stage[main]//Apt::Source[puppetlabs]/File[puppetlabs.list]/ensure: defined content as '{md5}3be1da4923fb910f1102a233b77e982e'
 272     info: /Stage[main]//Apt::Source[puppetlabs]/File[puppetlabs.list]: Scheduling refresh of Exec[puppetlabs apt update]
 273     notice: /Stage[main]//Apt::Source[puppetlabs]/Exec[puppetlabs apt update]: Triggered 'refresh' from 1 events>
 274
 275 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.
 276
 277 Implementation
 278 --------------
 279
 280 ### apt::backports
 281
 282 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).
 283
 284 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.
 285
 286 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.
 287
 288 Limitations
 289 -----------
 290
 291 This module should work across all versions of Debian/Ubuntu and support all major APT repository management features.
 292
 293 Development
 294 ------------
 295
 296 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.
 297
 298 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.
 299
 300 You can read the complete module contribution guide [on the Puppet Labs wiki.](http://projects.puppetlabs.com/projects/module-site/wiki/Module_contributing)
 301
 302 License
 303 -------
 304
 305 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.
 306
 307 The LICENSE contains both licenses.
 308
 309 Contributors
 310 ------------
 311
 312 A lot of great people have contributed to this module. A somewhat current list follows:
 313
 314 * Ben Godfrey <ben.godfrey@wonga.com>
 315 * Branan Purvine-Riley <branan@puppetlabs.com>
 316 * Christian G. Warden <cwarden@xerus.org>
 317 * Dan Bode <bodepd@gmail.com> <dan@puppetlabs.com>
 318 * Daniel Tremblay <github@danieltremblay.ca>
 319 * Garrett Honeycutt <github@garretthoneycutt.com>
 320 * Jeff Wallace <jeff@evolvingweb.ca> <jeff@tjwallace.ca>
 321 * Ken Barber <ken@bob.sh>
 322 * Matthaus Litteken <matthaus@puppetlabs.com> <mlitteken@gmail.com>
 323 * Matthias Pigulla <mp@webfactory.de>
 324 * Monty Taylor <mordred@inaugust.com>
 325 * Peter Drake <pdrake@allplayers.com>
 326 * Reid Vandewiele <marut@cat.pdx.edu>
 327 * Robert Navarro <rnavarro@phiivo.com>
 328 * Ryan Coleman <ryan@puppetlabs.com>
 329 * Scott McLeod <scott.mcleod@theice.com>
 330 * Spencer Krum <spencer@puppetlabs.com>
 331 * William Van Hevelingen <blkperl@cat.pdx.edu> <wvan13@gmail.com>
 332 * Zach Leslie <zach@puppetlabs.com>
 333 * Daniele Sluijters <github@daenney.net>
 334 * Daniel Paulus <daniel@inuits.eu>