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