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 ###apt::ppa
 105
 106 Adds a ppa repository using `add-apt-repository`.
 107
 108     apt::ppa { 'ppa:drizzle-developers/ppa': }
 109
 110 ###apt::release
 111
 112 Sets the default apt release. This class is particularly useful when using repositories, like Debian, that are unstable in Ubuntu.
 113
 114     class { 'apt::release':
 115       release_id => 'precise',
 116     }
 117
 118 ###apt::source
 119
 120 Adds an apt source to `/etc/apt/sources.list.d/`.
 121
 122     apt::source { 'debian_unstable':
 123       location          => 'http://debian.mirror.iweb.ca/debian/',
 124       release           => 'unstable',
 125       repos             => 'main contrib non-free',
 126       required_packages => 'debian-keyring debian-archive-keyring',
 127       key               => '55BE302B',
 128       key_server        => 'subkeys.pgp.net',
 129       pin               => '-10',
 130       include_src       => true
 131     }
 132
 133 If you would like to configure your system so the source is the Puppet Labs APT repository
 134
 135     apt::source { 'puppetlabs':
 136       location   => 'http://apt.puppetlabs.com',
 137       repos      => 'main',
 138       key        => '4BD6EC30',
 139       key_server => 'pgp.mit.edu',
 140     }
 141
 142 ###Testing
 143
 144 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.
 145
 146 ####Example Test
 147
 148 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
 149
 150     apt::source { 'puppetlabs':
 151       location   => 'http://apt.puppetlabs.com',
 152       repos      => 'main',
 153       key        => '4BD6EC30',
 154       key_server => 'pgp.mit.edu',
 155     }
 156
 157 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.
 158
 159 Check your smoke test for syntax errors
 160
 161     $ puppet parser validate tests/puppetlabs-apt.pp
 162
 163 If you receive no output from that command, it means nothing is wrong. Then apply the code
 164
 165     $ puppet apply --verbose tests/puppetlabs-apt.pp
 166     notice: /Stage[main]//Apt::Source[puppetlabs]/File[puppetlabs.list]/ensure: defined content as '{md5}3be1da4923fb910f1102a233b77e982e'
 167     info: /Stage[main]//Apt::Source[puppetlabs]/File[puppetlabs.list]: Scheduling refresh of Exec[puppetlabs apt update]
 168     notice: /Stage[main]//Apt::Source[puppetlabs]/Exec[puppetlabs apt update]: Triggered 'refresh' from 1 events>
 169
 170 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.
 171
 172 Implementation
 173 --------------
 174
 175 ###apt::backports
 176
 177 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).
 178
 179 Limitations
 180 -----------
 181
 182 This module should work across all versions of Debian/Ubuntu and support all major APT repository management features.
 183
 184 Development
 185 ------------
 186
 187 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.
 188
 189 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.
 190
 191 You can read the complete module contribution guide [on the Puppet Labs wiki.](http://projects.puppetlabs.com/projects/module-site/wiki/Module_contributing)
 192
 193 Contributors
 194 ------------
 195
 196 A lot of great people have contributed to this module. A somewhat current list follows:
 197
 198 * Ben Godfrey <ben.godfrey@wonga.com>
 199 * Branan Purvine-Riley <branan@puppetlabs.com>
 200 * Christian G. Warden <cwarden@xerus.org>
 201 * Dan Bode <bodepd@gmail.com> <dan@puppetlabs.com>
 202 * Garrett Honeycutt <github@garretthoneycutt.com>
 203 * Jeff Wallace <jeff@evolvingweb.ca> <jeff@tjwallace.ca>
 204 * Ken Barber <ken@bob.sh>
 205 * Matthaus Litteken <matthaus@puppetlabs.com> <mlitteken@gmail.com>
 206 * Matthias Pigulla <mp@webfactory.de>
 207 * Monty Taylor <mordred@inaugust.com>
 208 * Peter Drake <pdrake@allplayers.com>
 209 * Reid Vandewiele <marut@cat.pdx.edu>
 210 * Robert Navarro <rnavarro@phiivo.com>
 211 * Ryan Coleman <ryan@puppetlabs.com>
 212 * Scott McLeod <scott.mcleod@theice.com>
 213 * Spencer Krum <spencer@puppetlabs.com>
 214 * William Van Hevelingen <blkperl@cat.pdx.edu> <wvan13@gmail.com>
 215 * Zach Leslie <zach@puppetlabs.com>
 216
 217 Release Notes
 218 -------------
 219
 220 **1.1.0**
 221
 222 This release includes Ubuntu 12.10 (Quantal) support for PPAs.