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       update_timeout       => undef
  59     }
  60
  61 Puppet will manage your system's `sources.list` file and `sources.list.d` directory but will do its best to respect existing content.
  62
  63 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.
  64
  65 ###apt::builddep
  66
  67 Installs the build depends of a specified package.
  68
  69     apt::builddep { 'glusterfs-server': }
  70
  71 ###apt::force
  72
  73 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.
  74
  75     apt::force { 'glusterfs-server':
  76           release => 'unstable',
  77           version => '3.0.3',
  78           require => Apt::Source['debian_unstable'],
  79     }
  80
  81 ###apt::key
  82
  83 Adds a key to the list of keys used by APT to authenticate packages.
  84
  85     apt::key { 'puppetlabs':
  86       key        => '4BD6EC30',
  87       key_server => 'pgp.mit.edu',
  88     }
  89
  90     apt::key { 'jenkins':
  91       key        => 'D50582E6',
  92       key_source => 'http://pkg.jenkins-ci.org/debian/jenkins-ci.org.key',
  93     }
  94
  95 Note that use of `key_source` requires wget to be installed and working.
  96
  97 ###apt::pin
  98
  99 Adds an apt pin for a certain release.
 100
 101     apt::pin { 'karmic': priority => 700 }
 102     apt::pin { 'karmic-updates': priority => 700 }
 103     apt::pin { 'karmic-security': priority => 700 }
 104
 105 Note you can also specifying more complex pins using distribution properties.
 106
 107     apt::pin { 'stable':
 108       priority        => -10,
 109       originator      => 'Debian',
 110       release_version => '3.0',
 111       component       => 'main',
 112       label           => 'Debian'
 113     }
 114
 115 ###apt::ppa
 116
 117 Adds a ppa repository using `add-apt-repository`.
 118
 119     apt::ppa { 'ppa:drizzle-developers/ppa': }
 120
 121 ###apt::release
 122
 123 Sets the default apt release. This class is particularly useful when using repositories, like Debian, that are unstable in Ubuntu.
 124
 125     class { 'apt::release':
 126       release_id => 'precise',
 127     }
 128
 129 ###apt::source
 130
 131 Adds an apt source to `/etc/apt/sources.list.d/`.
 132
 133     apt::source { 'debian_unstable':
 134       location          => 'http://debian.mirror.iweb.ca/debian/',
 135       release           => 'unstable',
 136       repos             => 'main contrib non-free',
 137       required_packages => 'debian-keyring debian-archive-keyring',
 138       key               => '55BE302B',
 139       key_server        => 'subkeys.pgp.net',
 140       pin               => '-10',
 141       include_src       => true
 142     }
 143
 144 If you would like to configure your system so the source is the Puppet Labs APT repository
 145
 146     apt::source { 'puppetlabs':
 147       location   => 'http://apt.puppetlabs.com',
 148       repos      => 'main',
 149       key        => '4BD6EC30',
 150       key_server => 'pgp.mit.edu',
 151     }
 152
 153 ###Testing
 154
 155 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.
 156
 157 ####Example Test
 158
 159 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
 160
 161     apt::source { 'puppetlabs':
 162       location   => 'http://apt.puppetlabs.com',
 163       repos      => 'main',
 164       key        => '4BD6EC30',
 165       key_server => 'pgp.mit.edu',
 166     }
 167
 168 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.
 169
 170 Check your smoke test for syntax errors
 171
 172     $ puppet parser validate tests/puppetlabs-apt.pp
 173
 174 If you receive no output from that command, it means nothing is wrong. Then apply the code
 175
 176     $ puppet apply --verbose tests/puppetlabs-apt.pp
 177     notice: /Stage[main]//Apt::Source[puppetlabs]/File[puppetlabs.list]/ensure: defined content as '{md5}3be1da4923fb910f1102a233b77e982e'
 178     info: /Stage[main]//Apt::Source[puppetlabs]/File[puppetlabs.list]: Scheduling refresh of Exec[puppetlabs apt update]
 179     notice: /Stage[main]//Apt::Source[puppetlabs]/Exec[puppetlabs apt update]: Triggered 'refresh' from 1 events>
 180
 181 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.
 182
 183 Implementation
 184 --------------
 185
 186 ###apt::backports
 187
 188 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).
 189
 190 Limitations
 191 -----------
 192
 193 This module should work across all versions of Debian/Ubuntu and support all major APT repository management features.
 194
 195 Development
 196 ------------
 197
 198 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.
 199
 200 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.
 201
 202 You can read the complete module contribution guide [on the Puppet Labs wiki.](http://projects.puppetlabs.com/projects/module-site/wiki/Module_contributing)
 203
 204 Contributors
 205 ------------
 206
 207 A lot of great people have contributed to this module. A somewhat current list follows:
 208
 209 * Ben Godfrey <ben.godfrey@wonga.com>
 210 * Branan Purvine-Riley <branan@puppetlabs.com>
 211 * Christian G. Warden <cwarden@xerus.org>
 212 * Dan Bode <bodepd@gmail.com> <dan@puppetlabs.com>
 213 * Garrett Honeycutt <github@garretthoneycutt.com>
 214 * Jeff Wallace <jeff@evolvingweb.ca> <jeff@tjwallace.ca>
 215 * Ken Barber <ken@bob.sh>
 216 * Matthaus Litteken <matthaus@puppetlabs.com> <mlitteken@gmail.com>
 217 * Matthias Pigulla <mp@webfactory.de>
 218 * Monty Taylor <mordred@inaugust.com>
 219 * Peter Drake <pdrake@allplayers.com>
 220 * Reid Vandewiele <marut@cat.pdx.edu>
 221 * Robert Navarro <rnavarro@phiivo.com>
 222 * Ryan Coleman <ryan@puppetlabs.com>
 223 * Scott McLeod <scott.mcleod@theice.com>
 224 * Spencer Krum <spencer@puppetlabs.com>
 225 * William Van Hevelingen <blkperl@cat.pdx.edu> <wvan13@gmail.com>
 226 * Zach Leslie <zach@puppetlabs.com>