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     }
  59
  60 Puppet will manage your system's `sources.list` file and `sources.list.d` directory but will do its best to respect existing content.
  61
  62 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.
  63
  64 ### apt::builddep
  65
  66 Installs the build depends of a specified package.
  67
  68     apt::builddep { 'glusterfs-server': }
  69
  70 ### apt::force
  71
  72 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.
  73
  74     apt::force { 'glusterfs-server':
  75       release => 'unstable',
  76       version => '3.0.3',
  77       require => Apt::Source['debian_unstable'],
  78     }
  79
  80 ### apt_key
  81
  82 A native Puppet type and provider for managing GPG keys for APT is provided by
  83 this module.
  84
  85     apt_key { 'puppetlabs':
  86       ensure => 'present',
  87       id     => '4BD6EC30',
  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 it 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
 103 uses the aforementioned `apt_key` native type. As such it no longer requires
 104 the wget command that the old implementation depended on.
 105
 106     apt::key { 'puppetlabs':
 107       key        => '4BD6EC30',
 108       key_server => 'pgp.mit.edu',
 109     }
 110
 111     apt::key { 'jenkins':
 112       key        => 'D50582E6',
 113       key_source => 'http://pkg.jenkins-ci.org/debian/jenkins-ci.org.key',
 114     }
 115
 116 ### apt::pin
 117
 118 Adds an apt pin for a certain release.
 119
 120     apt::pin { 'karmic': priority => 700 }
 121     apt::pin { 'karmic-updates': priority => 700 }
 122     apt::pin { 'karmic-security': priority => 700 }
 123
 124 Note you can also specifying more complex pins using distribution properties.
 125
 126     apt::pin { 'stable':
 127       priority        => -10,
 128       originator      => 'Debian',
 129       release_version => '3.0',
 130       component       => 'main',
 131       label           => 'Debian'
 132     }
 133
 134 If you wish to pin a number of packages you may specify the packages as a space
 135 delimited string using the `packages` attribute or pass in an array of package
 136 names.
 137
 138 ### apt::hold
 139
 140 When you wish to hold a package in Puppet is should be done by passing in
 141 'held' as the ensure attribute to the package resource. However, a lot of
 142 public modules do not take this into account and generally do not work well
 143 with an ensure of 'held'.
 144
 145 There is an additional issue that when Puppet is told to hold a package, it
 146 will hold it at the current version installed, there is no way to tell it in
 147 one go to install a specific version and then hold that version without using
 148 an exec resource that wraps `dpkg --set-selections` or `apt-mark`.
 149
 150 At first glance this could also be solved by just passing the version required
 151 to the ensure attribute but that only means that Puppet will install that
 152 version once it processes that package. It does not inform apt that we want
 153 this package to be held. In other words; if another package somehow wants to
 154 upgrade this one (because of a version requirement in a dependency), apt
 155 should not allow it.
 156
 157 In order to solve this you can use apt::hold. It's implemented by creating
 158 a preferences file with a priority of 1001, meaning that under normal
 159 circumstances this preference will always win. Because the priority is > 1000
 160 apt will interpret this as 'this should be the version installed and I am
 161 allowed to downgrade the current package if needed'.
 162
 163 With this you can now set a package's ensure attribute to 'latest' but still
 164 get the version specified by apt::hold. You can do it like this:
 165
 166     apt::hold { 'vim':
 167       version => '2:7.3.547-7',
 168     }
 169
 170 Since you might just want to hold Vim at version 7.3 and not care about the
 171 rest you can also pass in a version with a glob:
 172
 173     apt::hold { 'vim':
 174       version => '2:7.3.*',
 175     }
 176
 177 ### apt::ppa
 178
 179 Adds a ppa repository using `add-apt-repository`.
 180
 181     apt::ppa { 'ppa:drizzle-developers/ppa': }
 182
 183 ### apt::release
 184
 185 Sets the default apt release. This class is particularly useful when using repositories, like Debian, that are unstable in Ubuntu.
 186
 187     class { 'apt::release':
 188       release_id => 'precise',
 189     }
 190
 191 ### apt::source
 192
 193 Adds an apt source to `/etc/apt/sources.list.d/`.
 194
 195     apt::source { 'debian_unstable':
 196       location          => 'http://debian.mirror.iweb.ca/debian/',
 197       release           => 'unstable',
 198       repos             => 'main contrib non-free',
 199       required_packages => 'debian-keyring debian-archive-keyring',
 200       key               => '46925553',
 201       key_server        => 'subkeys.pgp.net',
 202       pin               => '-10',
 203       include_src       => true
 204     }
 205
 206 If you would like to configure your system so the source is the Puppet Labs APT repository
 207
 208     apt::source { 'puppetlabs':
 209       location   => 'http://apt.puppetlabs.com',
 210       repos      => 'main',
 211       key        => '4BD6EC30',
 212       key_server => 'pgp.mit.edu',
 213     }
 214
 215
 216 #### Hiera example
 217 <pre>
 218 apt::sources:
 219   'debian_unstable':
 220       location: 'http://debian.mirror.iweb.ca/debian/'
 221       release: 'unstable'
 222       repos: 'main contrib non-free'
 223       required_packages: 'debian-keyring debian-archive-keyring'
 224       key: '55BE302B'
 225       key_server: 'subkeys.pgp.net'
 226       pin: '-10'
 227       include_src: 'true'
 228
 229   'puppetlabs':
 230       location: 'http://apt.puppetlabs.com'
 231       repos: 'main'
 232       key: '4BD6EC30'
 233       key_server: 'pgp.mit.edu'
 234 </pre>
 235
 236 ### Testing
 237
 238 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.
 239
 240 #### Example Test
 241
 242 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
 243
 244     apt::source { 'puppetlabs':
 245       location   => 'http://apt.puppetlabs.com',
 246       repos      => 'main',
 247       key        => '4BD6EC30',
 248       key_server => 'pgp.mit.edu',
 249     }
 250
 251 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.
 252
 253 Check your smoke test for syntax errors
 254
 255     $ puppet parser validate tests/puppetlabs-apt.pp
 256
 257 If you receive no output from that command, it means nothing is wrong. Then apply the code
 258
 259     $ puppet apply --verbose tests/puppetlabs-apt.pp
 260     notice: /Stage[main]//Apt::Source[puppetlabs]/File[puppetlabs.list]/ensure: defined content as '{md5}3be1da4923fb910f1102a233b77e982e'
 261     info: /Stage[main]//Apt::Source[puppetlabs]/File[puppetlabs.list]: Scheduling refresh of Exec[puppetlabs apt update]
 262     notice: /Stage[main]//Apt::Source[puppetlabs]/Exec[puppetlabs apt update]: Triggered 'refresh' from 1 events>
 263
 264 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.
 265
 266 Implementation
 267 --------------
 268
 269 ### apt::backports
 270
 271 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).
 272
 273 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.
 274
 275 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.
 276
 277 Limitations
 278 -----------
 279
 280 This module should work across all versions of Debian/Ubuntu and support all major APT repository management features.
 281
 282 Development
 283 ------------
 284
 285 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.
 286
 287 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.
 288
 289 You can read the complete module contribution guide [on the Puppet Labs wiki.](http://projects.puppetlabs.com/projects/module-site/wiki/Module_contributing)
 290
 291 License
 292 -------
 293
 294 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.
 295
 296 The LICENSE contains both licenses.
 297
 298 Contributors
 299 ------------
 300
 301 A lot of great people have contributed to this module. A somewhat current list follows:
 302
 303 * Ben Godfrey <ben.godfrey@wonga.com>
 304 * Branan Purvine-Riley <branan@puppetlabs.com>
 305 * Christian G. Warden <cwarden@xerus.org>
 306 * Dan Bode <bodepd@gmail.com> <dan@puppetlabs.com>
 307 * Daniel Tremblay <github@danieltremblay.ca>
 308 * Garrett Honeycutt <github@garretthoneycutt.com>
 309 * Jeff Wallace <jeff@evolvingweb.ca> <jeff@tjwallace.ca>
 310 * Ken Barber <ken@bob.sh>
 311 * Matthaus Litteken <matthaus@puppetlabs.com> <mlitteken@gmail.com>
 312 * Matthias Pigulla <mp@webfactory.de>
 313 * Monty Taylor <mordred@inaugust.com>
 314 * Peter Drake <pdrake@allplayers.com>
 315 * Reid Vandewiele <marut@cat.pdx.edu>
 316 * Robert Navarro <rnavarro@phiivo.com>
 317 * Ryan Coleman <ryan@puppetlabs.com>
 318 * Scott McLeod <scott.mcleod@theice.com>
 319 * Spencer Krum <spencer@puppetlabs.com>
 320 * William Van Hevelingen <blkperl@cat.pdx.edu> <wvan13@gmail.com>
 321 * Zach Leslie <zach@puppetlabs.com>
 322 * Daniele Sluijters <github@daenney.net>