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 ## Description
   7 Provides helpful definitions for dealing with Apt.
   8 =======
   9 Overview
  10 --------
  11
  12 The APT module provides a simple interface for managing APT source, key, and definitions with Puppet.
  13
  14 Module Description
  15 ------------------
  16
  17 APT automates obtaining and installing software packages on *nix systems.
  18
  19 Setup
  20 -----
  21
  22 **What APT affects:**
  23
  24 * package/service/configuration files for APT
  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 * wget (optional)
  30
  31 ###Beginning with APT
  32
  33 To begin using the APT module with default parameters, declare the class
  34
  35     class { 'apt': }
  36
  37 Puppet code that uses anything from the APT module requires that the core apt class be declared.
  38
  39 Usage
  40 -----
  41
  42 Using the APT module consists predominantly in declaring classes that provide desired functionality and features.
  43
  44 ###apt
  45
  46 `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.
  47
  48 The parameters for `apt` are not required in general and are predominantly for development environment use-cases.
  49
  50     class { 'apt':
  51       always_apt_update    => false,
  52       disable_keys         => undef,
  53       proxy_host           => false,
  54       proxy_port           => '8080',
  55       purge_sources_list   => false,
  56       purge_sources_list_d => false,
  57       purge_preferences_d  => false
  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` and `purge_sources_list_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 Adds a key to the list of keys used by APT to authenticate packages.
  83
  84     apt::key { 'puppetlabs':
  85       key        => '4BD6EC30',
  86       key_server => 'pgp.mit.edu',
  87     }
  88
  89     apt::key { 'jenkins':
  90       key        => 'D50582E6',
  91       key_source => 'http://pkg.jenkins-ci.org/debian/jenkins-ci.org.key',
  92     }
  93
  94 Note that use of `key_source` requires wget to be installed and working.
  95
  96 ###apt::pin
  97
  98 Adds an apt pin for a certain release.
  99
 100     apt::pin { 'karmic': priority => 700 }
 101     apt::pin { 'karmic-updates': priority => 700 }
 102     apt::pin { 'karmic-security': priority => 700 }
 103
 104 Note you can also specifying more complex pins using distribution properties.
 105
 106     apt::pin { 'stable':
 107       priority        => -10,
 108       originator      => 'Debian',
 109       release_version => '3.0',
 110       component       => 'main',
 111       label           => 'Debian'
 112     }
 113
 114 ###apt::ppa
 115
 116 Adds a ppa repository using `add-apt-repository`.
 117
 118     apt::ppa { 'ppa:drizzle-developers/ppa': }
 119
 120 ###apt::release
 121
 122 Sets the default apt release. This class is particularly useful when using repositories, like Debian, that are unstable in Ubuntu.
 123
 124     class { 'apt::release':
 125       release_id => 'precise',
 126     }
 127
 128 ###apt::source
 129
 130 Adds an apt source to `/etc/apt/sources.list.d/`.
 131
 132     apt::source { 'debian_unstable':
 133       location          => 'http://debian.mirror.iweb.ca/debian/',
 134       release           => 'unstable',
 135       repos             => 'main contrib non-free',
 136       required_packages => 'debian-keyring debian-archive-keyring',
 137       key               => '55BE302B',
 138       key_server        => 'subkeys.pgp.net',
 139       pin               => '-10',
 140       include_src       => true
 141     }
 142
 143 If you would like to configure your system so the source is the Puppet Labs APT repository
 144
 145     apt::source { 'puppetlabs':
 146       location   => 'http://apt.puppetlabs.com',
 147       repos      => 'main',
 148       key        => '4BD6EC30',
 149       key_server => 'pgp.mit.edu',
 150     }
 151
 152 ###Testing
 153
 154 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.
 155
 156 ####Example Test
 157
 158 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
 159
 160     apt::source { 'puppetlabs':
 161       location   => 'http://apt.puppetlabs.com',
 162       repos      => 'main',
 163       key        => '4BD6EC30',
 164       key_server => 'pgp.mit.edu',
 165     }
 166
 167 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.
 168
 169 Check your smoke test for syntax errors
 170
 171     $ puppet parser validate tests/puppetlabs-apt.pp
 172
 173 If you receive no output from that command, it means nothing is wrong. Then apply the code
 174
 175     $ puppet apply --verbose tests/puppetlabs-apt.pp
 176     notice: /Stage[main]//Apt::Source[puppetlabs]/File[puppetlabs.list]/ensure: defined content as '{md5}3be1da4923fb910f1102a233b77e982e'
 177     info: /Stage[main]//Apt::Source[puppetlabs]/File[puppetlabs.list]: Scheduling refresh of Exec[puppetlabs apt update]
 178     notice: /Stage[main]//Apt::Source[puppetlabs]/Exec[puppetlabs apt update]: Triggered 'refresh' from 1 events>
 179
 180 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.
 181
 182 Implementation
 183 --------------
 184
 185 ###apt::backports
 186
 187 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).
 188
 189 Limitations
 190 -----------
 191
 192 This module should work across all versions of Debian/Ubuntu and support all major APT repository management features.
 193
 194 Development
 195 ------------
 196
 197 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.
 198
 199 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.
 200
 201 You can read the complete module contribution guide [on the Puppet Labs wiki.](http://projects.puppetlabs.com/projects/module-site/wiki/Module_contributing)
 202
 203 Contributors
 204 ------------
 205
 206 A lot of great people have contributed to this module. A somewhat current list follows:
 207
 208 * Ben Godfrey <ben.godfrey@wonga.com>
 209 * Branan Purvine-Riley <branan@puppetlabs.com>
 210 * Christian G. Warden <cwarden@xerus.org>
 211 * Dan Bode <bodepd@gmail.com> <dan@puppetlabs.com>
 212 * Garrett Honeycutt <github@garretthoneycutt.com>
 213 * Jeff Wallace <jeff@evolvingweb.ca> <jeff@tjwallace.ca>
 214 * Ken Barber <ken@bob.sh>
 215 * Matthaus Litteken <matthaus@puppetlabs.com> <mlitteken@gmail.com>
 216 * Matthias Pigulla <mp@webfactory.de>
 217 * Monty Taylor <mordred@inaugust.com>
 218 * Peter Drake <pdrake@allplayers.com>
 219 * Reid Vandewiele <marut@cat.pdx.edu>
 220 * Robert Navarro <rnavarro@phiivo.com>
 221 * Ryan Coleman <ryan@puppetlabs.com>
 222 * Scott McLeod <scott.mcleod@theice.com>
 223 * Spencer Krum <spencer@puppetlabs.com>
 224 * William Van Hevelingen <blkperl@cat.pdx.edu> <wvan13@gmail.com>
 225 * Zach Leslie <zach@puppetlabs.com>