README.md

   1 # apt
   2
   3 [![Build Status](https://travis-ci.org/puppetlabs/puppetlabs-apt.png?branch=master)](https://travis-ci.org/puppetlabs/puppetlabs-apt)
   4
   5 ## Overview
   6
   7 The apt module provides a simple interface for managing Apt source, key, and definitions with Puppet.
   8
   9 ## Module Description
  10
  11 The apt module automates obtaining and installing software packages on \*nix systems.
  12
  13 **Note**: While this module allows the use of short keys, **we urge you NOT to use short keys**, as they pose a serious security issue by opening you up to collision attacks.
  14
  15 ## Setup
  16
  17 ### What apt affects:
  18
  19 * Package/service/configuration files for Apt
  20 * Your system's `sources.list` file and `sources.list.d` directory
  21 * System repositories
  22 * Authentication keys
  23
  24 **Note**: Setting the apt module's `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'.
  25
  26 ### Beginning with apt
  27
  28 To begin using the apt module with default parameters, declare the class with `include apt`.
  29
  30 Any Puppet code that uses anything from the apt module requires that the core apt class be declared.
  31
  32 ## Usage
  33
  34 Using the apt module consists predominantly of declaring classes and defined types that provide the desired functionality and features. This module provides common resources and options that are shared by the various defined types in the apt module, so you **must always** include this class in your manifests.
  35
  36 ```
  37 class { 'apt':
  38   always_apt_update    => false,
  39   apt_update_frequency => undef,
  40   disable_keys         => undef,
  41   proxy_host           => false,
  42   proxy_port           => '8080',
  43   purge_sources_list   => false,
  44   purge_sources_list_d => false,
  45   purge_preferences_d  => false,
  46   update_timeout       => undef,
  47   fancy_progress       => undef
  48 }
  49 ```
  50
  51 ## Reference
  52
  53 ### Classes
  54
  55 * `apt`: Main class, provides common resources and options. Allows Puppet to manage your system's sources.list file and sources.list.d directory, but it does its best to respect existing content.
  56
  57   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.
  58
  59 * `apt::backports`: This class adds the necessary components to get backports for Ubuntu and Debian. The release name defaults to `$lsbdistcodename`. Setting this manually can cause undefined and potentially serious behavior.
  60
  61   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.
  62
  63   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 Apt installs or upgrades to the newest version. This means that if a package is available from backports, it and its dependencies are pulled in from backports unless you explicitly set the `ensure` attribute of the `package` resource to `installed`/`present` or a specific version.
  64
  65 * `apt::params`: Sets defaults for the apt module parameters.
  66
  67 * `apt::release`: Sets the default Apt release. This class is particularly useful when using repositories that are unstable in Ubuntu, such as Debian.
  68
  69   ```
  70   class { 'apt::release':
  71     release_id => 'precise',
  72   }
  73   ```
  74
  75 * `apt::unattended_upgrades`: This class manages the unattended-upgrades package and related configuration files for Ubuntu and Debian systems. You can configure the class to automatically upgrade all new package releases or just security releases.
  76
  77   ```
  78   class { 'apt::unattended_upgrades':
  79     origins     => $::apt::params::origins,
  80     blacklist   => [],
  81     update      => '1',
  82     download    => '1',
  83     upgrade     => '1',
  84     autoclean   => '7',
  85   }
  86   ```
  87
  88 * `apt::update`: Runs `apt-get update`, updating the list of available packages and their versions without installing or upgrading any packages. The update runs on the first Puppet run after you include the class, then whenever `notify  => Exec['apt_update']` occurs; i.e., whenever config files get updated or other relevant changes occur. If you set the `always_apt_update` parameter to 'true', the update runs on every Puppet run.
  89
  90 ### Types
  91
  92 * `apt_key`
  93
  94   A native Puppet type and provider for managing GPG keys for Apt is provided by this module.
  95
  96   ```
  97   apt_key { 'puppetlabs':
  98     ensure => 'present',
  99     id     => '1054B7A24BD6EC30',
 100   }
 101   ```
 102
 103   You can additionally set the following attributes:
 104
 105    * `source`: HTTP, HTTPS or FTP location of a GPG key or path to a file on the target host.
 106    * `content`: Instead of pointing to a file, pass the key in as a string.
 107    * `server`: The GPG key server to use. It defaults to *keyserver.ubuntu.com*.
 108    * `keyserver_options`: Additional options to pass to `--keyserver`.
 109
 110   Because apt_key is a native type, you can use it and query for it with MCollective.
 111
 112 ### Defined Types
 113
 114 * `apt::builddep`: Installs the build dependencies of a specified package.
 115
 116   `apt::builddep { 'glusterfs-server': }`
 117
 118 * `apt::conf`: Specifies a custom configuration file. The priority defaults to 50, but you can set the priority parameter to load the file earlier or later. The content parameter passes specified content, if any, into the file resource.
 119
 120 * `apt::hold`: Holds a specific version of a package. You can hold a package to a full version or a partial version.
 121
 122   To set a package's ensure attribute to 'latest' but get the version specified by `apt::hold`:
 123
 124   ```
 125   apt::hold { 'vim':
 126     version => '2:7.3.547-7',
 127   }
 128   ```
 129
 130   Alternatively, if you want to hold your package at a partial version, you can use a wildcard. For example, you can hold Vim at version 7.3.*:
 131
 132
 133   ```
 134   apt::hold { 'vim':
 135     version => '2:7.3.*',
 136   }
 137   ```
 138
 139 * `apt::force`: Forces a package to be installed from a specific release. This is particularly useful when using repositories that are unstable in Ubuntu, such as Debian.
 140
 141   ```
 142   apt::force { 'glusterfs-server':
 143     release     => 'unstable',
 144     version     => '3.0.3',
 145     cfg_files   => 'unchanged',
 146     cfg_missing => true,
 147     require => Apt::Source['debian_unstable'],
 148   }
 149   ```
 150
 151   Valid values for `cfg_files` are:
 152     * 'new': Overwrites all existing configuration files with newer ones.
 153     * 'old': Forces usage of all old files.
 154     * 'unchanged: Updates only unchanged config files.
 155     * 'none': Provides backward-compatibility with existing Puppet manifests.
 156
 157   Valid values for `cfg_missing` are 'true', 'false'. Setting this to 'false' provides backward compatibility; setting it to 'true' checks for and installs missing configuration files for the selected package.
 158
 159 * `apt::key`: 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 the `wget` command on which the old implementation depended.
 160
 161   ```
 162   apt::key { 'puppetlabs':
 163     key        => '1054B7A24BD6EC30',
 164     key_server => 'pgp.mit.edu',
 165   }
 166
 167   apt::key { 'jenkins':
 168     key        => '9B7D32F2D50582E6',
 169     key_source => 'http://pkg.jenkins-ci.org/debian/jenkins-ci.org.key',
 170   }
 171   ```
 172
 173 * `apt::pin`: Defined type that adds an Apt pin for a certain release.
 174
 175   ```
 176   apt::pin { 'karmic': priority => 700 }
 177   apt::pin { 'karmic-updates': priority => 700 }
 178   apt::pin { 'karmic-security': priority => 700 }
 179   ```
 180
 181   Note that you can also specify more complex pins using distribution properties.
 182
 183   ```
 184   apt::pin { 'stable':
 185     priority        => -10,
 186     originator      => 'Debian',
 187     release_version => '3.0',
 188     component       => 'main',
 189     label           => 'Debian'
 190   }
 191   ```
 192
 193   If you want to pin a number of packages, you can specify the packages as a space-delimited string using the `packages` attribute, or you can pass in an array of package names.
 194
 195 * `apt::ppa`: Adds a PPA repository using `add-apt-repository`. For example, `apt::ppa { 'ppa:drizzle-developers/ppa': }`.
 196
 197 * `apt::source`: Adds an Apt source to `/etc/apt/sources.list.d/`. For example:
 198
 199   ```
 200   apt::source { 'debian_unstable':
 201     comment           => 'This is the iWeb Debian unstable mirror',
 202     location          => 'http://debian.mirror.iweb.ca/debian/',
 203     release           => 'unstable',
 204     repos             => 'main contrib non-free',
 205     required_packages => 'debian-keyring debian-archive-keyring',
 206     key               => '8B48AD6246925553',
 207     key_server        => 'subkeys.pgp.net',
 208     pin               => '-10',
 209     include_src       => true,
 210     include_deb       => true
 211   }
 212   ```
 213
 214   For example, to configure your system so the source is the Puppet Labs Apt repository:
 215
 216   ```
 217   apt::source { 'puppetlabs':
 218     location   => 'http://apt.puppetlabs.com',
 219     repos      => 'main',
 220     key        => '1054B7A24BD6EC30',
 221     key_server => 'pgp.mit.edu',
 222     }
 223   ```
 224
 225 ### Facts
 226
 227 The apt module includes a few facts to describe the state of the Apt system:
 228
 229 * `apt_updates`: The number of updates available on the system
 230 * `apt_security_updates`: The number of updates which are security updates
 231 * `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.
 232 * `apt_update_last_success`: The date, in epochtime, of the most recent successful `apt-get update` run. This is determined by reading the mtime of  /var/lib/apt/periodic/update-success-stamp.
 233
 234 **Note:** The facts depend on 'update-notifier' being installed on your system. Though this is a GNOME daemon only the support files are needed so the package 'update-notifier-common' is enough to enable this functionality.
 235
 236 #### Hiera example
 237
 238 ```
 239 <pre>
 240 apt::sources:
 241   'debian_unstable':
 242     location: 'http://debian.mirror.iweb.ca/debian/'
 243     release: 'unstable'
 244     repos: 'main contrib non-free'
 245     required_packages: 'debian-keyring debian-archive-keyring'
 246     key: '9AA38DCD55BE302B'
 247     key_server: 'subkeys.pgp.net'
 248     pin: '-10'
 249     include_src: 'true'
 250     include_deb: 'true'
 251
 252   'puppetlabs':
 253     location: 'http://apt.puppetlabs.com'
 254     repos: 'main'
 255     key: '1054B7A24BD6EC30'
 256     key_server: 'pgp.mit.edu'
 257 </pre>
 258 ```
 259
 260 ### Parameters
 261
 262 #### apt
 263
 264 * `always_apt_update`: Set to 'true' to update Apt on every run. This setting is intended for development environments where package updates are frequent. Defaults to 'false'.
 265 * `apt_update_frequency`: Sets the run frequency for `apt-get update`. Defaults to 'reluctantly'. Accepts the following values:
 266   * 'always': Runs update at every Puppet run.
 267   * 'daily': Runs update daily; that is, `apt-get update` runs if the value of `apt_update_last_success` is less than current epoch time - 86400. If the exec resource `apt_update` is notified, `apt-get update` runs regardless of this value.
 268   * 'weekly': Runs update weekly; that is, `apt-get update` runs if the value of `apt_update_last_success` is less than current epoch time - 604800. If the exec resource `apt_update` is notified, `apt-get update` runs regardless of this value.
 269   * 'reluctantly': Only runs `apt-get update` if the exec resource `apt_update` is notified. This is the default setting.
 270 * `disable_keys`: Disables the requirement for all packages to be signed.
 271 * `proxy_host`: Configures a proxy host and stores the configuration in /etc/apt/apt.conf.d/01proxy.
 272 * `proxy_port`: Configures a proxy port and stores the configuration in /etc/apt/apt.conf.d/01proxy.
 273 * `purge_sources_list`: If set to 'true', Puppet purges all unmanaged entries from sources.list. Accepts 'true' or 'false'. Defaults to 'false'.
 274 * `purge_sources_list_d`: If set to 'true', Puppet purges all unmanaged entries from sources.list.d. Accepts 'true' or 'false'. Defaults to 'false'.
 275 * `update_timeout`: Overrides the exec timeout in seconds for `apt-get update`. Defaults to exec default (300).
 276 * `update_tries`: Sets how many times to attempt running `apt-get update`. Use this to work around transient DNS and HTTP errors. By default, the command runs only once.
 277 * `sources`: Passes a hash to create_resource to make new `apt::source` resources.
 278 * `fancy_progress`: Enables fancy progress bars for apt. Accepts 'true', 'false'. Defaults to 'false'.
 279
 280 ####apt::unattended_upgrades
 281
 282 * `origins`: The repositories from which to automatically upgrade included packages.
 283 * `blacklist`: A list of packages to **not** automatically upgrade.
 284 * `update`: How often, in days, to run `apt-get update`.
 285 * `download`: How often, in days, to run `apt-get upgrade --download-only`.
 286 * `upgrade`: How often, in days, to upgrade packages included in the origins list.
 287 * `autoclean`: How often, in days, to run `apt-get autoclean`.
 288 * `randomsleep`: How long, in seconds, to randomly wait before applying upgrades.
 289
 290 ####apt::source
 291
 292 * `comment`: Add a comment to the apt source file.
 293 * `ensure`: Allows you to remove the apt source file. Can be 'present' or 'absent'.
 294 * `location`: The URL of the apt repository.
 295 * `release`: The distribution of the apt repository. Defaults to fact 'lsbdistcodename'.
 296 * `repos`: The component of the apt repository. This defaults to 'main'.
 297 * `include_deb`: References a Debian distribution's binary package.
 298 * `include_src`: Enable the deb-src type, references a Debian distribution's source code in the same form as the include_deb type. A deb-src line is required to fetch source indexes.
 299 * `required_packages`: install required packages via an exec. defaults to 'false'.
 300 * `key`: See apt::key
 301 * `key_server`: See apt::key
 302 * `key_content`: See apt::key
 303 * `key_source`: See apt::key
 304 * `pin`: See apt::pin
 305 * `architecture`: can be used to specify for which architectures information should be downloaded. If this option is not set all architectures defined by the APT::Architectures option will be downloaded. Defaults to 'undef' which means all. Example values can be 'i386' or 'i386,alpha,powerpc'.
 306 * `trusted_source` can be set to indicate that packages from this source are always authenticated even if the Release file is not signed or the signature can't be checked. Defaults to false. Can be 'true' or 'false'.
 307
 308 ####apt::key
 309
 310 * `ensure`: The state we want this key in. Can be 'present' or 'absent'.
 311 * `key`: Is a GPG key ID or full key fingerprint. This value is validated with a regex enforcing it to only contain valid hexadecimal characters, be precisely 8 or 16 hexadecimal characters long and optionally prefixed with 0x for key IDs, or 40 hexadecimal characters long for key fingerprints.
 312 * `key_content`: This parameter can be used to pass in a GPG key as a string in case it cannot be fetched from a remote location and using a file resource is for other reasons inconvenient.
 313 * `key_source`: This parameter can be used to pass in the location of a GPG key. This URI can take the form of a `URL` (ftp, http or https) and a `path` (absolute path to a file on the target system).
 314 * `key_server`: The keyserver from where to fetch our GPG key. It can either be a domain name or URL. It defaults to undef which results in apt_key's default keyserver being used, currently `keyserver.ubuntu.com`.
 315 * `key_options`: Additional options to pass on to `apt-key adv --keyserver-options`.
 316
 317 ####apt::pin
 318
 319 * `ensure`: The state we want this pin in. Can be 'present' or 'absent'.
 320 * `explanation`: Add a comment. Defaults to `${caller_module_name}: ${name}`.
 321 * `order`: The order of the file name. Defaults to '', otherwise must be an integer.
 322 * `packages`: The list of packages to pin. Defaults to '\*'. Can be an array or string.
 323 * `priority`: Several versions of a package may be available for installation when the sources.list(5) file contains references to more than one distribution (for example, stable and testing). APT assigns a priority to each version that is available. Subject to dependency constraints, apt-get selects the version with the highest priority for installation.
 324 * `release`: The Debian release. Defaults to ''. Typical values can be 'stable', 'testing' and 'unstable'.
 325 * `origin`: Can be used to match a hostname. The following record will assign a high priority to all versions available from the server identified by the hostname. Defaults to ''.
 326 * `version`: The specific form assigns a priority (a "Pin-Priority") to one or more specified packages with a specified version or version range.
 327 * `codename`: The distribution (lsbdistcodename) of the apt repository. Defaults to ''.
 328 * `release_version`: Names the release version. For example, the packages in the tree might belong to Debian release version 7. Defaults to ''.
 329 * `component`: Names the licensing component associated with the packages in the directory tree of the Release file. defaults to ''. Typical values can be 'main', 'dependencies' and 'restricted'
 330 * `originator`: Names the originator of the packages in the directory tree of the Release file. Defaults to ''. Most commonly, this is Debian.
 331 * `label`: Names the label of the packages in the directory tree of the Release file. Defaults to ''. Most commonly, this is Debian.
 332
 333 **Note**: Parameters release, origin, and version are mutually exclusive.
 334
 335 It is recommended to read the manpage 'apt_preferences(5)'
 336
 337 ### Testing
 338
 339 The apt module is mostly a collection of defined resource types, which provide reusable logic for managing 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.
 340
 341 #### Example Test
 342
 343 This test sets 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:
 344
 345 ```
 346 apt::source { 'puppetlabs':
 347   location   => 'http://apt.puppetlabs.com',
 348   repos      => 'main',
 349   key        => '1054B7A24BD6EC30',
 350   key_server => 'pgp.mit.edu',
 351 }
 352 ```
 353
 354 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.
 355
 356 Check your smoke test for syntax errors:
 357
 358 `$ puppet parser validate tests/puppetlabs-apt.pp`
 359
 360 If you receive no output from that command, it means nothing is wrong. Then, apply the code:
 361
 362 ```
 363 $ puppet apply --verbose tests/puppetlabs-apt.pp
 364 notice: /Stage[main]//Apt::Source[puppetlabs]/File[puppetlabs.list]/ensure: defined content as '{md5}3be1da4923fb910f1102a233b77e982e'
 365 info: /Stage[main]//Apt::Source[puppetlabs]/File[puppetlabs.list]: Scheduling refresh of Exec[puppetlabs apt update]
 366 notice: /Stage[main]//Apt::Source[puppetlabs]/Exec[puppetlabs apt update]: Triggered 'refresh' from 1 events>
 367 ```
 368
 369 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.
 370
 371 Limitations
 372 -----------
 373
 374 This module should work across all versions of Debian/Ubuntu and support all major Apt repository management features.
 375
 376 Development
 377 ------------
 378
 379 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.
 380
 381 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.
 382
 383 You can read the complete module contribution guide [on the Puppet Labs wiki.](http://projects.puppetlabs.com/projects/module-site/wiki/Module_contributing)
 384
 385 License
 386 -------
 387
 388 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.
 389
 390 The LICENSE contains both licenses.
 391
 392 Contributors
 393 ------------
 394
 395 A lot of great people have contributed to this module. A somewhat current list follows:
 396
 397 * Ben Godfrey <ben.godfrey@wonga.com>
 398 * Branan Purvine-Riley <branan@puppetlabs.com>
 399 * Christian G. Warden <cwarden@xerus.org>
 400 * Dan Bode <bodepd@gmail.com> <dan@puppetlabs.com>
 401 * Daniel Tremblay <github@danieltremblay.ca>
 402 * Garrett Honeycutt <github@garretthoneycutt.com>
 403 * Jeff Wallace <jeff@evolvingweb.ca> <jeff@tjwallace.ca>
 404 * Ken Barber <ken@bob.sh>
 405 * Matthaus Litteken <matthaus@puppetlabs.com> <mlitteken@gmail.com>
 406 * Matthias Pigulla <mp@webfactory.de>
 407 * Monty Taylor <mordred@inaugust.com>
 408 * Peter Drake <pdrake@allplayers.com>
 409 * Reid Vandewiele <marut@cat.pdx.edu>
 410 * Robert Navarro <rnavarro@phiivo.com>
 411 * Ryan Coleman <ryan@puppetlabs.com>
 412 * Scott McLeod <scott.mcleod@theice.com>
 413 * Spencer Krum <spencer@puppetlabs.com>
 414 * William Van Hevelingen <blkperl@cat.pdx.edu> <wvan13@gmail.com>
 415 * Zach Leslie <zach@puppetlabs.com>
 416 * Daniele Sluijters <github@daenney.net>
 417 * Daniel Paulus <daniel@inuits.eu>
 418 * Wolf Noble <wolf@wolfspyre.com>