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