Add testing, docs, and examples for backports

[puppet-modules/puppetlabs-apt.git] / README.md

# apt

## Overview

The apt module provides a simple interface for managing Apt source, key, and definitions with Puppet.

## Module Description

The apt module automates obtaining and installing software packages on \*nix systems.

**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.

## Setup

### What apt affects:

* Package/service/configuration files for Apt
* Your system's `sources.list` file and `sources.list.d` directory
* System repositories
* Authentication keys

**Note**: By default, this module will **destroy** any existing content in `sources.list` and `sources.list.d` that was not declared with Puppet.

### Beginning with apt

To begin using the apt module with default parameters, declare the class with `include apt`.

Any Puppet code that uses anything from the apt module requires that the core apt class be declared.

## Usage

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.

```puppet
class { 'apt': }
```

## Reference

### Classes

* `apt`: Main class, provides common resources and options. Allows Puppet to manage your system's sources.list file and sources.list.d directory. By default, it will purge any existing content it finds that wasn't declared with Puppet.
  
  * `apt::backports`: This class adds the necessary components to get backports for Ubuntu and Debian. The release name defaults to "$lsbdistcodename-backports". Setting this manually can cause undefined and potentially serious behavior.

    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.

      If you raise the priority through the `pin` 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.

* `apt::params`: Sets defaults for the apt module parameters.

* `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 `update['frequency']` to `'always'`, the update runs on every Puppet run.

### Types

* `apt_key`

  A native Puppet type and provider for managing GPG keys for Apt is provided by this module.

  ```puppet
  apt_key { 'puppetlabs':
    ensure => 'present',
    id     => '47B320EB4C7C375AA9DAE1A01054B7A24BD6EC30',
  }
  ```

  You can additionally set the following attributes:

   * `source`: HTTP, HTTPS or FTP location of a GPG key or path to a file on the target host.
   * `content`: Instead of pointing to a file, pass the key in as a string.
   * `server`: The GPG key server to use. It defaults to *keyserver.ubuntu.com*.
   * `options`: Additional options to pass to `apt-key`'s `--keyserver-options`.

### Defined Types

* `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.

* `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.

  ```puppet
  apt::key { 'puppetlabs':
    id     => '47B320EB4C7C375AA9DAE1A01054B7A24BD6EC30',
    server => 'pgp.mit.edu',
  }

  apt::key { 'jenkins':
    id     => '150FDE3F7787E7D11EF4E12A9B7D32F2D50582E6',
    source => 'http://pkg.jenkins-ci.org/debian/jenkins-ci.org.key',
  }
  ```

* `apt::pin`: Defined type that adds an Apt pin for a certain release.

  ```puppet
  apt::pin { 'karmic': priority => 700 }
  apt::pin { 'karmic-updates': priority => 700 }
  apt::pin { 'karmic-security': priority => 700 }
  ```

  Note that you can also specify more complex pins using distribution properties.

  ```puppet
  apt::pin { 'stable':
    priority        => -10,
    originator      => 'Debian',
    release_version => '3.0',
    component       => 'main',
    label           => 'Debian'
  }
  ```  

  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.

* `apt::ppa`: Adds a PPA repository using `add-apt-repository`. For example, `apt::ppa { 'ppa:drizzle-developers/ppa': }`.

* `apt::setting`: Defined type to abstract the creation of Apt configuration files.

* `apt::source`: Adds an Apt source to `/etc/apt/sources.list.d/`. For example:

  ```puppet
  apt::source { 'debian_unstable':
    comment  => 'This is the iWeb Debian unstable mirror',
    location => 'http://debian.mirror.iweb.ca/debian/',
    release  => 'unstable',
    repos    => 'main contrib non-free',
    pin      => '-10',
    key      => {
      'id'     => 'A1BD8E9D78F7FE5C3E65D8AF8B48AD6246925553',
      'server' => 'subkeys.pgp.net',
    },
    include  => {
      'src' => true,
      'deb' => true,
    },
  }
  ```  

  For example, to configure your system so the source is the Puppet Labs Apt repository:

  ```puppet
  apt::source { 'puppetlabs':
    location => 'http://apt.puppetlabs.com',
    repos    => 'main',
    key      => {
      'id'     => '47B320EB4C7C375AA9DAE1A01054B7A24BD6EC30',
      'server' => 'pgp.mit.edu',
    },
  ```

### Facts

The apt module includes a few facts to describe the state of the Apt system:

* `apt\_updates`: The number of updates available on the system
* `apt\_security\_updates`: The number of updates which are security updates
* `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.
* `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.

**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.

#### Hiera example

```yaml
apt::sources:
  'debian_unstable':
    location: 'http://debian.mirror.iweb.ca/debian/'
    release: 'unstable'
    repos: 'main contrib non-free'
    key:
      id: '9AA38DCD55BE302B'
      server: 'subkeys.pgp.net'
    pin: '-10'
    include:
      src: true
      deb: true

  'puppetlabs':
    location: 'http://apt.puppetlabs.com'
    repos: 'main'
    key:
      id: '47B320EB4C7C375AA9DAE1A01054B7A24BD6EC30'
      server: 'pgp.mit.edu'
```

### Parameters

####apt

* `update`: Hash to configure various update settings. Valid keys are:
  * 'frequency': The run frequency for `apt-get update`. Defaults to 'reluctantly'. Accepts the following values:
    * 'always': Runs update at every Puppet run.
    * '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. 
    * '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. 
    * 'reluctantly': Only runs `apt-get update` if the exec resource `apt\_update` is notified. This is the default setting.  
  * 'timeout': Overrides the exec timeout in seconds for `apt-get update`. Defaults to exec default (300).
  * '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.
* `purge`: Hash to configure various purge settings. Valid keys are:
  * 'sources.list': If set to 'true', Puppet purges all unmanaged entries from sources.list. Accepts `true` or `false`. Defaults to `true`.
  * 'sources.list.d': If set to 'true', Puppet purges all unmanaged entries from sources.list.d. Accepts `true` or `false`. Defaults to `true`.
  * 'preferences.list': If set to 'true', Puppet purges all unmanaged entries from preferences.list. Accepts `true` or `false`. Defaults to `true`.
  * 'preferences.list.d': If set to 'true', Puppet purges all unmanaged entries from preferences.list.d. Accepts `true` or `false`. Defaults to `true`.
* `proxy`: Hash to configure various proxy settings. Valid keys are:
  * 'host': Configures a proxy host and stores the configuration in /etc/apt/apt.conf.d/01proxy.
  * 'port': Configures a proxy port and stores the configuration in /etc/apt/apt.conf.d/01proxy.
  * 'https': Boolean to configure whether or not to enable https proxies. Defaults to false.
* `keys`: Passes a hash to `create\_resource` to make new `apt::key` resources.
* `ppas`: Passes a hash to `create\_resource` to make new `apt::ppa` resources.
* `settings`: Passes a hash to `create\_resource` to make new `apt::setting` resources.
* `sources`: Passes a hash to `create\_resource` to make new `apt::source` resources.

####apt::backports

* `location`: The URL of the apt repository. OS-dependent defaults are specifed in `apt::params` for Ubuntu and Debian. Required parameter for other OSes.
* `release`: The distribution of the apt repository. Defaults to "${lsbdistcodename}-backports" for Ubuntu and Debian. Required parameter for other OSes.
* `repos`: The component of the apt repository. OS-dependent defaults are speicifed in `apt::params` for Ubuntu and Debian. Required parameter for other OSes.
* `key`: The key for the backports repository. Can either be a string or a hash. See apt::setting for details on passing key as a hash. OS-dependent defaults are specified in `apt::params` for Ubuntu and Debian. Required parameter for other OSes.
* `pin`: The pin priority for backports repository. Can either be a number, a string, or a hash that will be passed as parameters to `apt::pin`. Defaults to `200`.

####apt::conf

* `content`: The content of the configuration file.
* `ensure`: Whether the configuration file should be 'present' or 'absent'. Defaults to 'present'.
* `priority`: Numeric priority for the configuration file. Defaults to '50'.

####apt::key

* `ensure`: The state we want this key in. Can be 'present' or 'absent'.
* `id`: 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.
* `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.
* `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).
* `server`: The keyserver from where to fetch our GPG key. It can either be a domain name or URL. It defaults to 'keyserver.ubuntu.com'.
* `options`: Additional options to pass on to `apt-key adv --keyserver-options`.

####apt::pin

* `ensure`: The state we want this pin in. Can be 'present' or 'absent'.
* `explanation`: Add a comment. Defaults to `${caller\_module\_name}: ${name}`.
* `order`: The order of the file name. Defaults to undef, otherwise must be an integer.
* `packages`: The list of packages to pin. Defaults to '\*'. Can be an array or string. 
* `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.
* `release`: The Debian release. Defaults to ''. Typical values can be 'stable', 'testing' and 'unstable'.
* `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 ''.
* `version`: The specific form assigns a priority (a "Pin-Priority") to one or more specified packages with a specified version or version range.
* `codename`: The distribution (lsbdistcodename) of the apt repository. Defaults to ''.
* `release\_version`: Names the release version. For example, the packages in the tree might belong to Debian release version 7. Defaults to ''.
* `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'
* `originator`: Names the originator of the packages in the directory tree of the Release file. Defaults to ''. Most commonly, this is Debian.
* `label`: Names the label of the packages in the directory tree of the Release file. Defaults to ''. Most commonly, this is Debian.

**Note**: Parameters release, origin, and version are mutually exclusive.

It is recommended to read the manpage 'apt_preferences(5)'

####apt::ppa

* `ensure`: Whether we are adding or removing the PPA. Can be 'present' or 'absent'. Defaults to 'present'.
* `release`: The codename for the operating system you're running. Defaults to `$lsbdistcodename`. Required if lsb-release is not installed.
* `options`: Options to be passed to the `apt-add-repository` command. OS-dependent defaults are set in `apt::params`.
* `package\_name`: The package that provides the `apt-add-repository` command. OS-dependent defaults are set in `apt::params`.
* `package\_manage`: Whether or not to manage the package providing `apt-add-repository`. Defaults to true.

####apt::setting

* `priority`: Integer or zero-padded integer setting the file priority. Defaults to 50.
* `ensure`: Whether to add or remove the file. Valid values are 'present', 'absent', and 'file'. Defaults to `file`.
* `source`: The source for the file. Exactly one of `content` and `source` must be specified.
* `content`: The content for the file. Exactly one of `content` and `source` must be specified.
* `notify\_update`: Boolean for whether or not this `apt::setting` should trigger an `apt-get update`. Defaults to `true`.

####apt::source

* `comment`: Add a comment to the apt source file.
* `ensure`: Allows you to remove the apt source file. Can be 'present' or 'absent'.
* `location`: The URL of the apt repository. Defaults to undef. Required unless `ensure => 'absent'`.
* `release`: The distribution of the apt repository. Defaults to fact 'lsbdistcodename'.
* `repos`: The component of the apt repository. This defaults to 'main'.
* `include`: Hash to configure include options. Valid keys are:
  * 'deb': References a Debian distribution's binary package. Defaults to `true`.
  * '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. Defaults to `false`.
* `key`: Add key from source. Takes either a string or a hash. If a string, the value will be passed to `id` in the `apt::key`. If a hash, valid keys are:
  * 'id': See `id` in `apt::key`. Required if a hash is specified.
  * 'server': See `server` in `apt::key`
  * 'content': See `content` in `apt::key`
  * 'source': See `source` in `apt::key`
  * 'options': See `options` in `apt::key`
* `pin`: See apt::pin. Defaults to undef. Can be a string, number, or a hash to be passed as parameters to `apt::pin`.
* `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'.
* `allow\_unsigned`: 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`.

Limitations
-----------

This module should work across all versions of Debian/Ubuntu and support all major Apt repository management features.

Development
------------

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.

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.

You can read the complete module contribution guide [on the Puppet Labs wiki.](http://projects.puppetlabs.com/projects/module-site/wiki/Module_contributing)

License
-------

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.

The LICENSE contains both licenses.

Contributors
------------

A lot of great people have contributed to this module. A somewhat current list follows:

* Ben Godfrey <ben.godfrey@wonga.com>
* Branan Purvine-Riley <branan@puppetlabs.com>
* Christian G. Warden <cwarden@xerus.org>
* Dan Bode <bodepd@gmail.com> <dan@puppetlabs.com>
* Daniel Tremblay <github@danieltremblay.ca>
* Garrett Honeycutt <github@garretthoneycutt.com>
* Jeff Wallace <jeff@evolvingweb.ca> <jeff@tjwallace.ca>
* Ken Barber <ken@bob.sh>
* Matthaus Litteken <matthaus@puppetlabs.com> <mlitteken@gmail.com>
* Matthias Pigulla <mp@webfactory.de>
* Monty Taylor <mordred@inaugust.com>
* Peter Drake <pdrake@allplayers.com>
* Reid Vandewiele <marut@cat.pdx.edu>
* Robert Navarro <rnavarro@phiivo.com>
* Ryan Coleman <ryan@puppetlabs.com>
* Scott McLeod <scott.mcleod@theice.com>
* Spencer Krum <spencer@puppetlabs.com>
* William Van Hevelingen <blkperl@cat.pdx.edu> <wvan13@gmail.com>
* Zach Leslie <zach@puppetlabs.com>
* Daniele Sluijters <github@daenney.net>
* Daniel Paulus <daniel@inuits.eu>
* Wolf Noble <wolf@wolfspyre.com>