README.md

   1 # apt
   2
   3 #### Table of Contents
   4
   5 1. [Overview](#overview)
   6 2. [Module Description - What the module does and why it is useful](#module-description)
   7 3. [Setup - The basics of getting started with apt](#setup)
   8     * [What apt affects](#what-apt-affects)
   9     * [Beginning with apt](#beginning-with-apt)
  10 4. [Usage - Configuration options and additional functionality](#usage)
  11 5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
  12     * [Classes](#classes)
  13     * [Defines](#defines)
  14     * [Types](#types)
  15     * [Facts](#facts)
  16 6. [Limitations - OS compatibility, etc.](#limitations)
  17 7. [Development - Guide for contributing to the module](#development)
  18
  19 ## Overview
  20
  21 The apt module lets you use Puppet to manage Apt sources, keys, and other configuration options.
  22
  23 ## Module Description
  24
  25 Apt (Advanced Package Tool) is a package manager available on Debian, Ubuntu, and several other operating systems. The apt module provides a series of classes, defines, types, and facts to help you automate Apt package management.
  26
  27 **Note**: For this module to be able to correctly auto detect which version of Debian/Ubuntu or derivative you're running you need to make sure the 'lsb-release' package is installed. We highly recommend making this part of your provisioning layer if you run many Debian or derivative systems or ensuring that you have at least Facter 2.2.0 installed which will pull in this dependency for you.
  28
  29 ## Setup
  30
  31 ### What apt affects
  32
  33 * Your system's `sources.list` file and `sources.list.d` directory
  34 * System repositories
  35 * Authentication keys
  36
  37 **Note:** Setting the apt module's `purge_sources_list` and `purge_sources_list_d` parameters to 'true' will destroy any existing content that you haven't declared through Puppet. The default for these parameters is 'false'.
  38
  39 ### Beginning with apt
  40
  41 To use the apt module with default parameters, declare the `apt` class.
  42
  43 ~~~puppet
  44 include apt
  45 ~~~
  46
  47 **Note:** The main `apt` class is required by all other classes, types, and defines in this module. You must declare it whenever you use the module.
  48
  49 ## Usage
  50
  51 ### Add GPG keys
  52
  53 **Warning:** Using short key IDs presents a serious security issue, potentially leaving you open to collision attacks. We recommend you always use full fingerprints to identify your GPG keys. This module allows short keys, but issues a security warning if you use them.
  54
  55 Declare the `apt::key` class:
  56
  57 ~~~puppet
  58 apt::key { 'puppetlabs':
  59   id      => '47B320EB4C7C375AA9DAE1A01054B7A24BD6EC30',
  60   server  => 'pgp.mit.edu',
  61   options => 'http-proxy="http://proxyuser:proxypass@example.org:3128"',
  62 }
  63 ~~~
  64
  65 You can make Apt load your key before others by adjusting the `priority` parameter (the default priority is 50).
  66
  67 ~~~puppet
  68 apt::key { 'puppetlabs':
  69   id       => '47B320EB4C7C375AA9DAE1A01054B7A24BD6EC30',
  70   server   => 'pgp.mit.edu',
  71   options  => 'http-proxy="http://proxyuser:proxypass@example.org:3128"',
  72   priority => '50',
  73 }
  74 ~~~
  75
  76 ### Prioritize backports
  77
  78 ~~~puppet
  79 class { 'apt::backports':
  80   pin => 500,
  81 }
  82 ~~~
  83
  84 By default, the `apt::backports` class drops a pin file for backports, pinning it to a priority of 200. This is lower than the normal default of 500, so packages with `ensure => latest` don't get upgraded from backports without your explicit permission.
  85
  86 If you raise the priority through the `pin` parameter to 500, normal policy goes into effect and Apt installs or upgrades to the newest version. This means that if a package is available from backports, it and its dependencies are pulled in from backports unless you explicitly set the `ensure` attribute of the `package` resource to `installed`/`present` or a specific version.
  87
  88 ### Update the list of packages
  89
  90 By default, Puppet runs `apt-get update` on the first Puppet run after you include the `apt` class, and anytime `notify  => Exec['apt_update']` occurs; i.e., whenever config files get updated or other relevant changes occur. If you set `update['frequency']` to 'always', the update runs on every Puppet run. You can also set `update['frequency']` to 'daily' or 'weekly':
  91
  92 ~~~puppet
  93 class { 'apt':
  94   update => {
  95     frequency => 'daily',
  96   },
  97 }
  98 ~~~
  99
 100 ### Pin a specific release
 101
 102 ~~~puppet
 103 apt::pin { 'karmic': priority => 700 }
 104 apt::pin { 'karmic-updates': priority => 700 }
 105 apt::pin { 'karmic-security': priority => 700 }
 106 ~~~
 107
 108 You can also specify more complex pins using distribution properties:
 109
 110 ~~~puppet
 111 apt::pin { 'stable':
 112   priority        => -10,
 113   originator      => 'Debian',
 114   release_version => '3.0',
 115   component       => 'main',
 116   label           => 'Debian'
 117 }
 118 ~~~
 119
 120 To pin multiple packages, pass them to the `packages` parameter as an array or a space-delimited string.
 121
 122 ### Add a PPA (Personal Package Archive) repository
 123
 124 ~~~puppet
 125 apt::ppa { 'ppa:drizzle-developers/ppa': }
 126 ~~~
 127
 128 ### Add an Apt source to `/etc/apt/sources.list.d/`
 129
 130 ~~~puppet
 131 apt::source { 'debian_unstable':
 132   comment  => 'This is the iWeb Debian unstable mirror',
 133   location => 'http://debian.mirror.iweb.ca/debian/',
 134   release  => 'unstable',
 135   repos    => 'main contrib non-free',
 136   pin      => '-10',
 137   key      => {
 138     'id'     => 'A1BD8E9D78F7FE5C3E65D8AF8B48AD6246925553',
 139     'server' => 'subkeys.pgp.net',
 140   },
 141   include  => {
 142     'src' => true,
 143     'deb' => true,
 144   },
 145 }
 146 ~~~
 147
 148 To use the Puppet Labs Apt repository as a source:
 149
 150 ~~~puppet
 151 apt::source { 'puppetlabs':
 152   location => 'http://apt.puppetlabs.com',
 153   repos    => 'main',
 154   key      => {
 155     'id'     => '47B320EB4C7C375AA9DAE1A01054B7A24BD6EC30',
 156     'server' => 'pgp.mit.edu',
 157   },
 158 },
 159 ~~~
 160
 161 ### Configure Apt from Hiera
 162
 163 ~~~yaml
 164 apt::sources:
 165   'debian_unstable':
 166     location: 'http://debian.mirror.iweb.ca/debian/'
 167     release: 'unstable'
 168     repos: 'main contrib non-free'
 169     key:
 170       id: '9AA38DCD55BE302B'
 171       server: 'subkeys.pgp.net'
 172     pin: '-10'
 173     include:
 174       src: true
 175       deb: true
 176
 177   'puppetlabs':
 178     location: 'http://apt.puppetlabs.com'
 179     repos: 'main'
 180     key:
 181       id: '47B320EB4C7C375AA9DAE1A01054B7A24BD6EC30'
 182       server: 'pgp.mit.edu'
 183 ~~~
 184
 185 ## Reference
 186
 187 ### Classes
 188
 189 #### Public Classes
 190
 191 * [`apt`](#class-apt)
 192 * [`apt::backports`](#class-aptbackports)
 193
 194 #### Private Classes
 195
 196 * `apt::params`: Provides defaults for the apt module parameters.
 197 * `apt::update`: Updates the list of available packages using `apt-get update`.
 198
 199 ### Defines
 200
 201 * [`apt::conf`](#define-aptconf)
 202 * [`apt::key`](#define-aptkey)
 203 * [`apt::pin`](#define-aptpin)
 204 * [`apt::ppa`](#define-aptppa)
 205 * [`apt::setting`](#define-aptsetting)
 206 * [`apt::source`](#define-aptsource)
 207
 208 ### Types
 209
 210 * [`apt_key`](#type-apt_key)
 211
 212 ### Facts
 213
 214 * `apt_updates`: The number of installed packages with available updates.
 215
 216 * `apt_security_updates`: The number of installed packages with available security updates.
 217
 218 * `apt_package_updates`: The names of all installed packages with available updates. In Facter 2.0 and later this data is formatted as an array; in earlier versions it is a comma-delimited string.
 219
 220 * `apt_update_last_success`: The date, in epochtime, of the most recent successful `apt-get update` run (based on the mtime of  /var/lib/apt/periodic/update-success-stamp).
 221
 222 #### Class: `apt`
 223
 224 Main class, includes all other classes.
 225
 226 ##### Parameters (all optional)
 227
 228 * `keys`: Creates new `apt::key` resources. Valid options: a hash to be passed to the [`create_resources` function](https://docs.puppetlabs.com/references/latest/function.html#createresources). Default: {}.
 229
 230 * `ppas`: Creates new `apt::ppa` resources. Valid options: a hash to be passed to the [`create_resources` function](https://docs.puppetlabs.com/references/latest/function.html#createresources). Default: {}.
 231
 232 * `proxy`: Configures Apt to connect to a proxy server. Valid options: a hash made up from the following keys:
 233
 234   * 'host': Specifies a proxy host to be stored in `/etc/apt/apt.conf.d/01proxy`. Valid options: a string containing a hostname. Default: undef.
 235
 236   * 'port': Specifies a proxy port to be stored in `/etc/apt/apt.conf.d/01proxy`. Valid options: a string containing a port number. Default: '8080'.
 237
 238   * 'https': Specifies whether to enable https proxies. Valid options: 'true' and 'false'. Default: 'false'.
 239
 240 * `purge`: Specifies whether to purge any existing settings that aren't managed by Puppet. Valid options: a hash made up from the following keys:
 241
 242   * 'sources.list': Specifies whether to purge any unmanaged entries from `sources.list`. Valid options: 'true' and 'false'. Default: 'false'.
 243
 244   * 'sources.list.d': Specifies whether to purge any unmanaged entries from `sources.list.d`. Valid options: 'true' and 'false'. Default: 'false'.
 245
 246   * 'preferences.list': Specifies whether to purge any unmanaged entries from `preferences.list`. Valid options: 'true' and 'false'. Default: 'false'.
 247
 248   * 'preferences.list.d': Specifies whether to purge any unmanaged entries from `preferences.list.d`. Valid options: 'true' and 'false'. Default: 'false'.
 249
 250 * `settings`: Creates new `apt::setting` resources. Valid options: a hash to be passed to the [`create_resources` function](https://docs.puppetlabs.com/references/latest/function.html#createresources). Default: {}.
 251
 252 * `sources`: Creates new `apt::setting` resources. Valid options: a hash to be passed to the [`create_resources` function](https://docs.puppetlabs.com/references/latest/function.html#createresources). Default: {}.
 253
 254 * `update`: Configures various update settings. Valid options: a hash made up from the following keys:
 255
 256   * 'frequency': Specifies how often to run `apt-get update`. If the exec resource `apt_update` is notified, `apt-get update` runs regardless of this value. Valid options: 'always' (at every Puppet run); 'daily' (if the value of `apt_update_last_success` is less than current epoch time minus 86400); 'weekly' (if the value of `apt_update_last_success` is less than current epoch time minus 604800); and 'reluctantly' (only if the exec resource `apt_update` is notified). Default: 'reluctantly'.
 257
 258   * 'timeout': Specifies how long to wait for the update to complete before canceling it. Valid options: an integer, in seconds. Default: 300.
 259
 260   * 'tries': Specifies how many times to retry the update after receiving a DNS or HTTP error. Valid options: an integer. Default: 1.
 261
 262 #### Class: `apt::backports`
 263
 264 Manages backports.
 265
 266 ##### Parameters (all optional on Debian and Ubuntu; all required on other operating systems, except where specified)
 267
 268 * `key`: Specifies a key to authenticate the backports. Valid options: a string to be passed to the `id` parameter of the `apt::key` define, or a hash of `parameter => value` pairs to be passed to `apt::key`'s `id`, `server`, `content`, `source`, and/or `options` parameters. Defaults:
 269
 270   * Debian: 'A1BD8E9D78F7FE5C3E65D8AF8B48AD6246925553'
 271   * Ubuntu: '630239CC130E1A7FD81A27B140976EAF437D05B5'
 272
 273 * `location`: Specifies an Apt repository containing the backports to manage. Valid options: a string containing a URL. Defaults:
 274
 275   * Debian (squeeze): 'http://backports.debian.org/debian-backports'
 276   * Debian (other): 'http://ftp.debian.org/debian/'
 277   * Ubuntu: 'http://archive.ubuntu.com/ubuntu'
 278
 279 * `pin`: *Optional.* Specifies a pin priority for the backports. Valid options: a number or string to be passed to the `id` parameter of the `apt::pin` define, or a hash of `parameter => value` pairs to be passed to `apt::pin`'s corresponding parameters. Default: '200'.
 280
 281 * `release`: Specifies a distribution of the Apt repository containing the backports to manage. Valid options: a string containing the release, used in populating the `source.list` configuration file. Default: on Debian and Ubuntu, '${lsbdistcodename}-backports'. We recommend keeping this default, except on other operating systems.
 282
 283 * `repos`: Specifies a component of the Apt repository containing the backports to manage. Valid options: A string containing the repos to include, used in populating the `source.list` configuration file. Defaults:
 284
 285   * Debian: 'main contrib non-free'
 286   * Ubuntu: 'main universe multiverse restricted'
 287
 288 #### Define: `apt::conf`
 289
 290 Specifies a custom Apt configuration file.
 291
 292 ##### Parameters
 293
 294 * `content`: *Required, unless `ensure` is set to 'absent'.* Directly supplies content for the configuration file. Valid options: a string. Default: undef.
 295
 296 * `ensure`: Specifies whether the configuration file should exist. Valid options: 'present' and 'absent'. Default: 'present'.
 297
 298 * `priority`: *Optional.* Determines the order in which Apt processes the configuration file. Files with lower priority numbers are loaded first. Valid options: a string containing an integer. Default: '50'.
 299
 300 #### Define: `apt::key`
 301
 302 Manages the GPG keys that Apt uses to authenticate packages.
 303
 304 The `apt::key` define makes use of the `apt_key` type, but includes extra functionality to help prevent duplicate keys.
 305
 306 ##### Parameters (all optional)
 307
 308 * `content`: Supplies the entire GPG key. Useful in case the key can't be fetched from a remote location and using a file resource is inconvenient. Valid options: a string. Default: undef.
 309
 310 * `ensure`: Specifies whether the key should exist. Valid options: 'present' and 'absent'. Default: 'present'.
 311
 312 * `id`: Specifies a GPG key to authenticate Apt package signatures. Valid options: a string containing a key ID (8 or 16 hexadecimal characters, optionally prefixed with "0x") or a full key fingerprint (40 hexadecimal characters). Default: $title.
 313
 314 * `options`: Passes additional options to `apt-key adv --keyserver-options`. Valid options: a string. Default: undef.
 315
 316 * `source`: Specifies the location of an existing GPG key file to copy. Valid options: a string containing a URL (ftp://, http://, or https://) or an absolute path. Default: undef.
 317
 318 * `server`: Specifies a keyserver to provide the GPG key. Valid options: a string containing a domain name or a full URL (http://, https://, or hkp://). Default: 'keyserver.ubuntu.com'.
 319
 320 #### Define: `apt::pin`
 321
 322 Manages Apt pins.
 323
 324 **Note:** For context on these parameters, we recommend reading the man page ['apt_preferences(5)'](http://linux.die.net/man/5/apt_preferences)
 325
 326 ##### Parameters (all optional)
 327
 328 * `codename`: Specifies the distribution (lsbdistcodename) of the Apt repository. Valid options: a string. Default: ''.
 329
 330 * `component`: Names the licensing component associated with the packages in the directory tree of the Release file. Valid options: a string. Default: ''.
 331
 332 * `ensure`: Specifies whether the pin should exist. Valid options: 'file', 'present', and 'absent'. Default: 'present'.
 333
 334 * `explanation`: Supplies a comment to explain the pin. Valid options: a string. Default: "${caller_module_name}: ${name}".
 335
 336 * `label`: Names the label of the packages in the directory tree of the Release file. Valid options: a string (most commonly, 'debian'). Default: ''.
 337
 338 * `order`: Determines the order in which Apt processes the pin file. Files with lower order numbers are loaded first. Valid options: an integer. Default: 50.
 339
 340 * `origin`: Tells Apt to prefer packages from the specified server. Valid options: a string containing a hostname. Default: ''.
 341
 342 * `originator`: Names the originator of the packages in the directory tree of the Release file. Valid options: a string (most commonly, 'debian'). Default: ''.
 343
 344 * `packages`: Specifies which package(s) to pin. Valid options: a string or an array. Default: '*'.
 345
 346 * `priority`: Sets the priority of the package. If multiple versions of a given package are available, `apt-get` installs the one with the highest priority number (subject to dependency constraints). Valid options: an integer. Default: 0.
 347
 348 * `release`: Tells Apt to prefer packages that support the specified release. Typical values include 'stable', 'testing', and 'unstable' Valid options: a string. Default: ''.
 349
 350 * `release_version`: Tells Apt to prefer packages that support the specified operating system release version (e.g., Debian release version 7). Valid options: a string. Default: ''.
 351
 352 * `version`: Tells Apt to prefer a specified package version or version range. Valid options: a string. Default: ''.
 353
 354 #### Define: `apt::ppa`
 355
 356 Manages PPA repositories using `add-apt-repository`. Not supported on Debian.
 357
 358 ##### Parameters (all optional, except where specified)
 359
 360 * `ensure`: Specifies whether the PPA should exist. Valid options: 'present' and 'absent'. Default: 'present'.
 361
 362 * `options`: Supplies options to be passed to the `add-apt-repository` command. Valid options: a string. Defaults:
 363
 364   * Lucid: undef
 365   * All others: '-y'
 366
 367 * `package_manage`: Specifies whether Puppet should manage the package that provides `apt-add-repository`. Valid options: 'true' and 'false'. Default: 'false'.
 368
 369 * `package_name`: Names the package that provides the `apt-add-repository` command. Valid options: a string. Defaults:
 370
 371   * Lucid and Precise: 'python-software-properties'
 372   * Trusty, Utopic, and Vivid: 'software-properties-common'
 373   * All others: undef
 374
 375 * `release`: *Optional if lsb-release is installed (unless you're using a different release than indicated by lsb-release, e.g., Linux Mint).* Specifies the operating system of your node. Valid options: a string containing a valid LSB distribution codename. Default: "$lsbdistcodename".
 376
 377 #### Define: `apt:setting`
 378
 379 Manages Apt configuration files.
 380
 381 ##### Parameters
 382
 383 * `content`: *Required, unless `source` is set.* Directly supplies content for the configuration file. Cannot be used in combination with `source`. Valid options: see the `content` attribute of [Puppet's native `file` type](https://docs.puppetlabs.com/references/latest/type.html#file-attribute-content). Default: undef.
 384
 385 * `ensure`: Specifies whether the file should exist. Valid options: 'present', 'absent', and 'file'. Default: 'file'.
 386
 387 * `notify_update`: *Optional.* Specifies whether to trigger an `apt-get update` run. Valid options: 'true' and 'false'. Default: 'true'.
 388
 389 * `priority`: *Optional.* Determines the order in which Apt processes the configuration file. Files with higher priority numbers are loaded first. Valid options: an integer or zero-padded integer. Default: 50.
 390
 391 * `source`: *Required, unless `content` is set.* Specifies a source file to supply the content of the configuration file. Cannot be used in combination with `content`. Valid options: see the `source` attribute of [Puppet's native `file` type](https://docs.puppetlabs.com/references/latest/type.html#file-attribute-source). Default: undef.
 392
 393 #### Define: `apt::source`
 394
 395 Manages the Apt sources in `/etc/apt/sources.list.d/`.
 396
 397 ##### Parameters (all optional, except where specified)
 398
 399 * `allow_unsigned`: Specifies whether to authenticate packages from this release, even if the Release file is not signed or the signature can't be checked. Valid options: 'true' and 'false'. Default: 'false'.
 400
 401 * `architecture`: Tells Apt to only download information for specified architectures. Valid options: a string containing one or more architecture names, separated by commas (e.g., 'i386' or 'i386,alpha,powerpc'). Default: undef (if unspecified, Apt downloads information for all architectures defined in the Apt::Architectures option).
 402
 403 * `comment`: Supplies a comment for adding to the Apt source file. Valid options: a string. Default: $name.
 404
 405 * `ensure`: Specifies whether the Apt source file should exist. Valid options: 'present' and 'absent'. Default: 'present'.
 406
 407 * `key`: Creates a declaration of the apt::key define Valid options: a string to be passed to the `id` parameter of the `apt::key` define, or a hash of `parameter => value` pairs to be passed to `apt::key`'s `id`, `server`, `content`, `source`, and/or `options` parameters. Default: undef.
 408
 409 * `include`: Configures include options. Valid options: a hash made up from the following keys:
 410
 411 * 'deb' - Specifies whether to request the distribution's compiled binaries. Valid options: 'true' and 'false. Default: 'true'.
 412
 413 * 'src' - Specifies whether to request the distribution's uncompiled source code. Valid options: 'true' and 'false'. Default: 'false'. Default: {}.
 414
 415 * `location`: *Required, unless `ensure` is set to 'absent'.* Specifies an Apt repository. Valid options: a string containing a repository URL. Default: undef.
 416
 417 * `pin`: Creates a declaration of the apt::pin define Valid options: a number or string to be passed to the `id` parameter of the `apt::pin` define, or a hash of `parameter => value` pairs to be passed to `apt::pin`'s corresponding parameters. Default: undef.
 418
 419 * `release`: Specifies a distribution of the Apt repository. Valid options: a string. Default: "$lsbdistcodename".
 420
 421 * `repos`: Specifies a component of the Apt repository. Valid options: a string. Default: 'main'.
 422
 423 #### Type: `apt_key`
 424
 425 Manages the GPG keys that Apt uses to authenticate packages.
 426
 427 **Note:** In most cases, we recommend using the `apt::key` define. It makes use of the `apt_key` type, but includes extra functionality to help prevent duplicate keys.
 428
 429 ##### Parameters (all optional)
 430
 431 * `content`: Supplies the entire GPG key. Useful in case the key can't be fetched from a remote location and using a file resource is inconvenient. Cannot be used in combination with `source`. Valid options: a string. Default: undef.
 432
 433 * `options`: Passes additional options to `apt-key adv --keyserver-options`. Valid options: a string. Default: undef.
 434
 435 * `server`: Specifies a keyserver to provide Puppet's GPG key. Valid options: a string containing a domain name or a full URL. Default: 'keyserver.ubuntu.com'.
 436
 437 * `source`: Specifies the location of an existing GPG key file to copy. Cannot be used in combination with `content`. Valid options: a string containing a URL (ftp://, http://, or https://) or an absolute path. Default: undef.
 438
 439 ## Limitations
 440
 441 This module is tested and officially supported on Debian 6 and 7 and Ubuntu 10.04, 12.04, and 14.04. Testing on other platforms has been light and cannot be guaranteed.
 442
 443 ## Development
 444 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 hardware, software, and deployment configurations that Puppet is intended to serve. 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.
 445
 446 For more information, see our [module contribution guide.](https://docs.puppetlabs.com/forge/contributing.html)
 447
 448 To see who's already involved, see the [list of contributors.](https://github.com/puppetlabs/puppetlabs-apt/graphs/contributors)