README.md

   1 # apt
   2
   3 ## Overview
   4
   5 The apt module provides a simple interface for managing Apt source, key, and definitions with Puppet.
   6
   7 ## Module Description
   8
   9 The apt module automates obtaining and installing software packages on \*nix systems.
  10
  11 **Note**: While this module allows the use of short keys, **warnings are thrown if a full fingerprint is not used**, as they pose a serious security issue by opening you up to collision attacks.
  12
  13 ## Setup
  14
  15 ### What apt affects:
  16
  17 * Package/service/configuration files for Apt
  18 * Your system's `sources.list` file and `sources.list.d` directory
  19 * System repositories
  20 * Authentication keys
  21
  22 **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'.
  23
  24 ### Beginning with apt
  25
  26 To begin using the apt module with default parameters, declare the class with `include apt`.
  27
  28 Any Puppet code that uses anything from the apt module requires that the core apt class be declared.
  29
  30 ## Usage
  31
  32 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.
  33
  34 ```
  35 class { 'apt':
  36   always_apt_update    => false,
  37   apt_update_frequency => undef,
  38   disable_keys         => undef,
  39   proxy_host           => false,
  40   proxy_port           => '8080',
  41   purge_sources_list   => false,
  42   purge_sources_list_d => false,
  43   purge_preferences_d  => false,
  44   update_timeout       => undef,
  45   fancy_progress       => undef
  46 }
  47 ```
  48
  49 ## Reference
  50
  51 ### Classes
  52
  53 * `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.
  54
  55   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.
  56
  57 * `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.
  58
  59   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.
  60
  61   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.
  62
  63 * `apt::params`: Sets defaults for the apt module parameters.
  64
  65 * `apt::release`: Sets the default Apt release. This class is particularly useful when using repositories that are unstable in Ubuntu, such as Debian.
  66
  67   ```
  68   class { 'apt::release':
  69     release_id => 'precise',
  70   }
  71   ```
  72
  73 * `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.
  74
  75   ```
  76   class { 'apt::unattended_upgrades':
  77     blacklist     => [],
  78     update        => '1',
  79     download      => '1',
  80     upgrade       => '1',
  81     autoclean     => '7',
  82   }
  83   ```
  84
  85 * `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.
  86
  87 ### Types
  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   ```
  94   apt_key { 'puppetlabs':
  95     ensure => 'present',
  96     id     => '1054B7A24BD6EC30',
  97   }
  98   ```
  99
 100   You can additionally set the following attributes:
 101
 102    * `source`: HTTP, HTTPS or FTP location of a GPG key or path to a file on the target host.
 103    * `content`: Instead of pointing to a file, pass the key in as a string.
 104    * `server`: The GPG key server to use. It defaults to *keyserver.ubuntu.com*.
 105    * `keyserver_options`: Additional options to pass to `--keyserver`.
 106
 107   Because apt_key is a native type, you can use it and query for it with MCollective.
 108
 109 ### Defined Types
 110
 111 * `apt::builddep`: Installs the build dependencies of a specified package.
 112
 113   `apt::builddep { 'glusterfs-server': }`
 114
 115 * `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.
 116
 117 * `apt::hold`: Holds a specific version of a package. You can hold a package to a full version or a partial version.
 118
 119   To set a package's ensure attribute to 'latest' but get the version specified by `apt::hold`:
 120
 121   ```
 122   apt::hold { 'vim':
 123     version => '2:7.3.547-7',
 124   }
 125   ```
 126
 127   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.*:
 128
 129
 130   ```
 131   apt::hold { 'vim':
 132     version => '2:7.3.*',
 133   }
 134   ```
 135
 136 * `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.
 137
 138   ```
 139   apt::force { 'glusterfs-server':
 140     release     => 'unstable',
 141     version     => '3.0.3',
 142     cfg_files   => 'unchanged',
 143     cfg_missing => true,
 144     require => Apt::Source['debian_unstable'],
 145   }
 146   ```
 147
 148   Valid values for `cfg_files` are:
 149     * 'new': Overwrites all existing configuration files with newer ones.
 150     * 'old': Forces usage of all old files.
 151     * 'unchanged: Updates only unchanged config files.
 152     * 'none': Provides backward-compatibility with existing Puppet manifests.
 153
 154   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.
 155
 156 * `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.
 157
 158   ```
 159   apt::key { 'puppetlabs':
 160     key        => '1054B7A24BD6EC30',
 161     key_server => 'pgp.mit.edu',
 162   }
 163
 164   apt::key { 'jenkins':
 165     key        => '9B7D32F2D50582E6',
 166     key_source => 'http://pkg.jenkins-ci.org/debian/jenkins-ci.org.key',
 167   }
 168   ```
 169
 170 * `apt::pin`: Defined type that adds an Apt pin for a certain release.
 171
 172   ```
 173   apt::pin { 'karmic': priority => 700 }
 174   apt::pin { 'karmic-updates': priority => 700 }
 175   apt::pin { 'karmic-security': priority => 700 }
 176   ```
 177
 178   Note that you can also specify more complex pins using distribution properties.
 179
 180   ```
 181   apt::pin { 'stable':
 182     priority        => -10,
 183     originator      => 'Debian',
 184     release_version => '3.0',
 185     component       => 'main',
 186     label           => 'Debian'
 187   }
 188   ```
 189
 190   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.
 191
 192 * `apt::ppa`: Adds a PPA repository using `add-apt-repository`. For example, `apt::ppa { 'ppa:drizzle-developers/ppa': }`.
 193
 194 * `apt::source`: Adds an Apt source to `/etc/apt/sources.list.d/`. For example:
 195
 196   ```
 197   apt::source { 'debian_unstable':
 198     comment           => 'This is the iWeb Debian unstable mirror',
 199     location          => 'http://debian.mirror.iweb.ca/debian/',
 200     release           => 'unstable',
 201     repos             => 'main contrib non-free',
 202     required_packages => 'debian-keyring debian-archive-keyring',
 203     key               => 'A1BD8E9D78F7FE5C3E65D8AF8B48AD6246925553',
 204     key_server        => 'subkeys.pgp.net',
 205     pin               => '-10',
 206     include_src       => true,
 207     include_deb       => true
 208   }
 209   ```
 210
 211   For example, to configure your system so the source is the Puppet Labs Apt repository:
 212
 213   ```
 214   apt::source { 'puppetlabs':
 215     location   => 'http://apt.puppetlabs.com',
 216     repos      => 'main',
 217     key        => '1054B7A24BD6EC30',
 218     key_server => 'pgp.mit.edu',
 219     }
 220   ```
 221
 222 ### Facts
 223
 224 The apt module includes a few facts to describe the state of the Apt system:
 225
 226 * `apt_updates`: The number of updates available on the system
 227 * `apt_security_updates`: The number of updates which are security updates
 228 * `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.
 229 * `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.
 230
 231 **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.
 232
 233 #### Hiera example
 234
 235 ```
 236 <pre>
 237 apt::sources:
 238   'debian_unstable':
 239     location: 'http://debian.mirror.iweb.ca/debian/'
 240     release: 'unstable'
 241     repos: 'main contrib non-free'
 242     required_packages: 'debian-keyring debian-archive-keyring'
 243     key: '9AA38DCD55BE302B'
 244     key_server: 'subkeys.pgp.net'
 245     pin: '-10'
 246     include_src: true
 247     include_deb: true
 248
 249   'puppetlabs':
 250     location: 'http://apt.puppetlabs.com'
 251     repos: 'main'
 252     key: '1054B7A24BD6EC30'
 253     key_server: 'pgp.mit.edu'
 254 </pre>
 255 ```
 256
 257 ### Parameters
 258
 259 #### apt
 260
 261 * `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'.
 262 * `apt_update_frequency`: Sets the run frequency for `apt-get update`. Defaults to 'reluctantly'. Accepts the following values:
 263   * 'always': Runs update at every Puppet run.
 264   * '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.
 265   * '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.
 266   * 'reluctantly': Only runs `apt-get update` if the exec resource `apt_update` is notified. This is the default setting.
 267 * `disable_keys`: Disables the requirement for all packages to be signed.
 268 * `proxy_host`: Configures a proxy host and stores the configuration in /etc/apt/apt.conf.d/01proxy.
 269 * `proxy_port`: Configures a proxy port and stores the configuration in /etc/apt/apt.conf.d/01proxy.
 270 * `purge_sources_list`: If set to 'true', Puppet purges all unmanaged entries from sources.list. Accepts 'true' or 'false'. Defaults to 'false'.
 271 * `purge_sources_list_d`: If set to 'true', Puppet purges all unmanaged entries from sources.list.d. Accepts 'true' or 'false'. Defaults to 'false'.
 272 * `update_timeout`: Overrides the exec timeout in seconds for `apt-get update`. Defaults to exec default (300).
 273 * `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.
 274 * `sources`: Passes a hash to create_resource to make new `apt::source` resources.
 275 * `fancy_progress`: Enables fancy progress bars for apt. Accepts 'true', 'false'. Defaults to 'false'.
 276
 277 ####apt::unattended_upgrades
 278
 279 * `legacy_origin`: If set to true, use the old `Unattended-Upgrade::Allowed-Origins` variable. If false, use `Unattended-Upgrade::Origins-Pattern`. OS-dependent defaults are defined in `apt::params`.
 280 * `origins`: The repositories from which to automatically upgrade included packages.
 281 * `blacklist`: A list of packages to **not** automatically upgrade.
 282 * `update`: How often, in days, to run `apt-get update`.
 283 * `download`: How often, in days, to run `apt-get upgrade --download-only`.
 284 * `upgrade`: How often, in days, to upgrade packages included in the origins list.
 285 * `autoclean`: How often, in days, to run `apt-get autoclean`.
 286 * `randomsleep`: How long, in seconds, to randomly wait before applying upgrades.
 287
 288 ####apt::source
 289
 290 * `comment`: Add a comment to the apt source file.
 291 * `ensure`: Allows you to remove the apt source file. Can be 'present' or 'absent'.
 292 * `location`: The URL of the apt repository.
 293 * `release`: The distribution of the apt repository. Defaults to fact 'lsbdistcodename'.
 294 * `repos`: The component of the apt repository. This defaults to 'main'.
 295 * `include_deb`: References a Debian distribution's binary package.
 296 * `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.
 297 * `required_packages`: install required packages via an exec. defaults to 'false'.
 298 * `key`: See apt::key
 299 * `key_server`: See apt::key
 300 * `key_content`: See apt::key
 301 * `key_source`: See apt::key
 302 * `pin`: See apt::pin
 303 * `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'.
 304 * `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'.
 305
 306 ####apt::key
 307
 308 * `ensure`: The state we want this key in. Can be 'present' or 'absent'.
 309 * `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.
 310 * `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.
 311 * `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).
 312 * `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`.
 313 * `key_options`: Additional options to pass on to `apt-key adv --keyserver-options`.
 314
 315 ####apt::pin
 316
 317 * `ensure`: The state we want this pin in. Can be 'present' or 'absent'.
 318 * `explanation`: Add a comment. Defaults to `${caller_module_name}: ${name}`.
 319 * `order`: The order of the file name. Defaults to '', otherwise must be an integer.
 320 * `packages`: The list of packages to pin. Defaults to '\*'. Can be an array or string.
 321 * `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.
 322 * `release`: The Debian release. Defaults to ''. Typical values can be 'stable', 'testing' and 'unstable'.
 323 * `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 ''.
 324 * `version`: The specific form assigns a priority (a "Pin-Priority") to one or more specified packages with a specified version or version range.
 325 * `codename`: The distribution (lsbdistcodename) of the apt repository. Defaults to ''.
 326 * `release_version`: Names the release version. For example, the packages in the tree might belong to Debian release version 7. Defaults to ''.
 327 * `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'
 328 * `originator`: Names the originator of the packages in the directory tree of the Release file. Defaults to ''. Most commonly, this is Debian.
 329 * `label`: Names the label of the packages in the directory tree of the Release file. Defaults to ''. Most commonly, this is Debian.
 330
 331 **Note**: Parameters release, origin, and version are mutually exclusive.
 332
 333 It is recommended to read the manpage 'apt_preferences(5)'
 334
 335 ####apt::ppa
 336
 337 * `ensure`: Whether we are adding or removing the PPA. Can be 'present' or 'absent'. Defaults to 'present'.
 338 * `release`: The codename for the operating system you're running. Defaults to `$lsbdistcodename`. Required if lsb-release is not installed.
 339 * `options`: Options to be passed to the `apt-add-repository` command. OS-dependent defaults are set in `apt::params`.
 340 * `package_name`: The package that provides the `apt-add-repository` command. OS-dependent defaults are set in `apt::params`.
 341 * `package_manage`: Whether or not to manage the package providing `apt-add-repository`. Defaults to true.
 342
 343 ### Testing
 344
 345 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.
 346
 347 #### Example Test
 348
 349 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:
 350
 351 ```
 352 apt::source { 'puppetlabs':
 353   location   => 'http://apt.puppetlabs.com',
 354   repos      => 'main',
 355   key        => '1054B7A24BD6EC30',
 356   key_server => 'pgp.mit.edu',
 357 }
 358 ```
 359
 360 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.
 361
 362 Check your smoke test for syntax errors:
 363
 364 `$ puppet parser validate tests/puppetlabs-apt.pp`
 365
 366 If you receive no output from that command, it means nothing is wrong. Then, apply the code:
 367
 368 ```
 369 $ puppet apply --verbose tests/puppetlabs-apt.pp
 370 notice: /Stage[main]//Apt::Source[puppetlabs]/File[puppetlabs.list]/ensure: defined content as '{md5}3be1da4923fb910f1102a233b77e982e'
 371 info: /Stage[main]//Apt::Source[puppetlabs]/File[puppetlabs.list]: Scheduling refresh of Exec[puppetlabs apt update]
 372 notice: /Stage[main]//Apt::Source[puppetlabs]/Exec[puppetlabs apt update]: Triggered 'refresh' from 1 events>
 373 ```
 374
 375 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.
 376
 377 Limitations
 378 -----------
 379
 380 This module should work across all versions of Debian/Ubuntu and support all major Apt repository management features.
 381
 382 Development
 383 ------------
 384
 385 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.
 386
 387 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.
 388
 389 You can read the complete module contribution guide [on the Puppet Labs wiki.](http://projects.puppetlabs.com/projects/module-site/wiki/Module_contributing)
 390
 391 License
 392 -------
 393
 394 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.
 395
 396 The LICENSE contains both licenses.
 397
 398 Contributors
 399 ------------
 400
 401 A lot of great people have contributed to this module. A somewhat current list follows:
 402
 403 * Ben Godfrey <ben.godfrey@wonga.com>
 404 * Branan Purvine-Riley <branan@puppetlabs.com>
 405 * Christian G. Warden <cwarden@xerus.org>
 406 * Dan Bode <bodepd@gmail.com> <dan@puppetlabs.com>
 407 * Daniel Tremblay <github@danieltremblay.ca>
 408 * Garrett Honeycutt <github@garretthoneycutt.com>
 409 * Jeff Wallace <jeff@evolvingweb.ca> <jeff@tjwallace.ca>
 410 * Ken Barber <ken@bob.sh>
 411 * Matthaus Litteken <matthaus@puppetlabs.com> <mlitteken@gmail.com>
 412 * Matthias Pigulla <mp@webfactory.de>
 413 * Monty Taylor <mordred@inaugust.com>
 414 * Peter Drake <pdrake@allplayers.com>
 415 * Reid Vandewiele <marut@cat.pdx.edu>
 416 * Robert Navarro <rnavarro@phiivo.com>
 417 * Ryan Coleman <ryan@puppetlabs.com>
 418 * Scott McLeod <scott.mcleod@theice.com>
 419 * Spencer Krum <spencer@puppetlabs.com>
 420 * William Van Hevelingen <blkperl@cat.pdx.edu> <wvan13@gmail.com>
 421 * Zach Leslie <zach@puppetlabs.com>
 422 * Daniele Sluijters <github@daenney.net>
 423 * Daniel Paulus <daniel@inuits.eu>
 424 * Wolf Noble <wolf@wolfspyre.com>