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 ## Setup
  28
  29 ### What apt affects
  30
  31 * Your system's `sources.list` file and `sources.list.d` directory
  32 * System repositories
  33 * Authentication keys
  34
  35 **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'.
  36
  37 ### Beginning with apt
  38
  39 To use the apt module with default parameters, declare the `apt` class.
  40
  41 ~~~puppet
  42 include apt
  43 ~~~
  44
  45 **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.
  46
  47 ## Usage
  48
  49 ### Add GPG keys
  50
  51 **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.
  52
  53 Declare the `apt::key` class:
  54
  55 ~~~puppet
  56 apt::key { 'puppetlabs':
  57   id      => '47B320EB4C7C375AA9DAE1A01054B7A24BD6EC30',
  58   server  => 'pgp.mit.edu',
  59   options => 'http-proxy="http://proxyuser:proxypass@example.org:3128"',
  60 }
  61 ~~~
  62
  63 You can make Apt load your key before others by adjusting the `priority` parameter (the default priority is 50).
  64
  65 ~~~puppet
  66 apt::key { 'puppetlabs':
  67   id       => '47B320EB4C7C375AA9DAE1A01054B7A24BD6EC30',
  68   server   => 'pgp.mit.edu',
  69   options  => 'http-proxy="http://proxyuser:proxypass@example.org:3128"',
  70   priority => '50',
  71 }
  72 ~~~
  73
  74 ### Prioritize backports
  75
  76 ~~~puppet
  77 class { 'apt::backports':
  78   pin => 500,
  79 }
  80 ~~~
  81
  82 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.
  83
  84 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.
  85
  86 ### Update the list of packages
  87
  88 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':
  89
  90 ~~~puppet
  91 class { 'apt':
  92   update => {
  93     frequency => 'daily',
  94   },
  95 }
  96 ~~~
  97
  98 ### Pin a specific release
  99
 100 ~~~puppet
 101 apt::pin { 'karmic': priority => 700 }
 102 apt::pin { 'karmic-updates': priority => 700 }
 103 apt::pin { 'karmic-security': priority => 700 }
 104 ~~~
 105
 106 You can also specify more complex pins using distribution properties:
 107
 108 ~~~puppet
 109 apt::pin { 'stable':
 110   priority        => -10,
 111   originator      => 'Debian',
 112   release_version => '3.0',
 113   component       => 'main',
 114   label           => 'Debian'
 115 }
 116 ~~~
 117
 118 To pin multiple packages, pass them to the `packages` parameter as an array or a space-delimited string.
 119
 120 ### Add a PPA (Personal Package Archive) repository
 121
 122 ~~~puppet
 123 apt::ppa { 'ppa:drizzle-developers/ppa': }
 124 ~~~
 125
 126 ### Add an Apt source to `/etc/apt/sources.list.d/`
 127
 128 ~~~puppet
 129 apt::source { 'debian_unstable':
 130   comment  => 'This is the iWeb Debian unstable mirror',
 131   location => 'http://debian.mirror.iweb.ca/debian/',
 132   release  => 'unstable',
 133   repos    => 'main contrib non-free',
 134   pin      => '-10',
 135   key      => {
 136     'id'     => 'A1BD8E9D78F7FE5C3E65D8AF8B48AD6246925553',
 137     'server' => 'subkeys.pgp.net',
 138   },
 139   include  => {
 140     'src' => true,
 141     'deb' => true,
 142   },
 143 }
 144 ~~~
 145
 146 To use the Puppet Labs Apt repository as a source:
 147
 148 ~~~puppet
 149 apt::source { 'puppetlabs':
 150   location => 'http://apt.puppetlabs.com',
 151   repos    => 'main',
 152   key      => {
 153     'id'     => '47B320EB4C7C375AA9DAE1A01054B7A24BD6EC30',
 154     'server' => 'pgp.mit.edu',
 155   },
 156 },
 157 ~~~
 158
 159 ### Configure Apt from Hiera
 160
 161 ~~~yaml
 162 apt::sources:
 163   'debian_unstable':
 164     location: 'http://debian.mirror.iweb.ca/debian/'
 165     release: 'unstable'
 166     repos: 'main contrib non-free'
 167     key:
 168       id: '9AA38DCD55BE302B'
 169       server: 'subkeys.pgp.net'
 170     pin: '-10'
 171     include:
 172       src: true
 173       deb: true
 174
 175   'puppetlabs':
 176     location: 'http://apt.puppetlabs.com'
 177     repos: 'main'
 178     key:
 179       id: '47B320EB4C7C375AA9DAE1A01054B7A24BD6EC30'
 180       server: 'pgp.mit.edu'
 181 ~~~
 182
 183 ## Reference
 184
 185 ### Classes
 186
 187 #### Public Classes
 188
 189 * [`apt`](#class-apt)
 190 * [`apt::backports`](#class-aptbackports)
 191
 192 #### Private Classes
 193
 194 * `apt::params`: Provides defaults for the apt module parameters.
 195 * `apt::update`: Updates the list of available packages using `apt-get update`.
 196
 197 ### Defines
 198
 199 * [`apt::conf`](#define-aptconf)
 200 * [`apt::key`](#define-aptkey)
 201 * [`apt::pin`](#define-aptpin)
 202 * [`apt::ppa`](#define-aptppa)
 203 * [`apt::setting`](#define-aptsetting)
 204 * [`apt::source`](#define-aptsource)
 205
 206 ### Types
 207
 208 * [`apt_key`](#type-apt_key)
 209
 210 ### Facts
 211
 212 * `apt_updates`: The number of installed packages with available updates.
 213
 214 * `apt_security_updates`: The number of installed packages with available security updates.
 215
 216 * `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.
 217
 218 * `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).
 219
 220 #### Class: `apt`
 221
 222 Main class, includes all other classes.
 223
 224 ##### Parameters (all optional)
 225
 226 * `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: {}.
 227
 228 * `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: {}.
 229
 230 * `proxy`: Configures Apt to connect to a proxy server. Valid options: a hash made up from the following keys:
 231
 232   * 'host': Specifies a proxy host to be stored in `/etc/apt/apt.conf.d/01proxy`. Valid options: a string containing a hostname. Default: undef.
 233
 234   * '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'.
 235
 236   * 'https': Specifies whether to enable https proxies. Valid options: 'true' and 'false'. Default: 'false'.
 237
 238 * `purge`: Specifies whether to purge any existing settings that aren't managed by Puppet. Valid options: a hash made up from the following keys:
 239
 240   * 'sources.list': Specifies whether to purge any unmanaged entries from `sources.list`. Valid options: 'true' and 'false'. Default: 'false'.
 241
 242   * 'sources.list.d': Specifies whether to purge any unmanaged entries from `sources.list.d`. Valid options: 'true' and 'false'. Default: 'false'.
 243
 244   * 'preferences.list': Specifies whether to purge any unmanaged entries from `preferences.list`. Valid options: 'true' and 'false'. Default: 'false'.
 245
 246   * 'preferences.list.d': Specifies whether to purge any unmanaged entries from `preferences.list.d`. Valid options: 'true' and 'false'. Default: 'false'.
 247
 248 * `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: {}.
 249
 250 * `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: {}.
 251
 252 * `update`: Configures various update settings. Valid options: a hash made up from the following keys:
 253
 254   * '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'.
 255
 256   * 'timeout': Specifies how long to wait for the update to complete before canceling it. Valid options: an integer, in seconds. Default: 300.
 257
 258   * 'tries': Specifies how many times to retry the update after receiving a DNS or HTTP error. Valid options: an integer. Default: 1.
 259
 260 #### Class: `apt::backports`
 261
 262 Manages backports.
 263
 264 ##### Parameters (all optional on Debian and Ubuntu; all required on other operating systems, except where specified)
 265
 266 * `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:
 267
 268   * Debian: 'A1BD8E9D78F7FE5C3E65D8AF8B48AD6246925553'
 269   * Ubuntu: '630239CC130E1A7FD81A27B140976EAF437D05B5'
 270
 271 * `location`: Specifies an Apt repository containing the backports to manage. Valid options: a string containing a URL. Defaults:
 272
 273   * Debian (squeeze): 'http://backports.debian.org/debian-backports'
 274   * Debian (other): 'http://ftp.debian.org/debian/'
 275   * Ubuntu: 'http://archive.ubuntu.com/ubuntu'
 276
 277 * `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'.
 278
 279 * `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.
 280
 281 * `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:
 282
 283   * Debian: 'main contrib non-free'
 284   * Ubuntu: 'main universe multiverse restricted'
 285
 286 #### Define: `apt::conf`
 287
 288 Specifies a custom Apt configuration file.
 289
 290 ##### Parameters
 291
 292 * `content`: *Required, unless `ensure` is set to 'absent'.* Directly supplies content for the configuration file. Valid options: a string. Default: undef.
 293
 294 * `ensure`: Specifies whether the configuration file should exist. Valid options: 'present' and 'absent'. Default: 'present'.
 295
 296 * `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'.
 297
 298 #### Define: `apt::key`
 299
 300 Manages the GPG keys that Apt uses to authenticate packages.
 301
 302 The `apt::key` define makes use of the `apt_key` type, but includes extra functionality to help prevent duplicate keys.
 303
 304 ##### Parameters (all optional)
 305
 306 * `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.
 307
 308 * `ensure`: Specifies whether the key should exist. Valid options: 'present' and 'absent'. Default: 'present'.
 309
 310 * `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.
 311
 312 * `options`: Passes additional options to `apt-key adv --keyserver-options`. Valid options: a string. Default: undef.
 313
 314 * `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.
 315
 316 * `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'.
 317
 318 #### Define: `apt::pin`
 319
 320 Manages Apt pins.
 321
 322 **Note:** For context on these parameters, we recommend reading the man page ['apt_preferences(5)'](http://linux.die.net/man/5/apt_preferences)
 323
 324 ##### Parameters (all optional)
 325
 326 * `codename`: Specifies the distribution (lsbdistcodename) of the Apt repository. Valid options: a string. Default: ''.
 327
 328 * `component`: Names the licensing component associated with the packages in the directory tree of the Release file. Valid options: a string. Default: ''.
 329
 330 * `ensure`: Specifies whether the pin should exist. Valid options: 'file', 'present', and 'absent'. Default: 'present'.
 331
 332 * `explanation`: Supplies a comment to explain the pin. Valid options: a string. Default: "${caller_module_name}: ${name}".
 333
 334 * `label`: Names the label of the packages in the directory tree of the Release file. Valid options: a string (most commonly, 'debian'). Default: ''.
 335
 336 * `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.
 337
 338 * `origin`: Tells Apt to prefer packages from the specified server. Valid options: a string containing a hostname. Default: ''.
 339
 340 * `originator`: Names the originator of the packages in the directory tree of the Release file. Valid options: a string (most commonly, 'debian'). Default: ''.
 341
 342 * `packages`: Specifies which package(s) to pin. Valid options: a string or an array. Default: '*'.
 343
 344 * `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.
 345
 346 * `release`: Tells Apt to prefer packages that support the specified release. Typical values include 'stable', 'testing', and 'unstable' Valid options: a string. Default: ''.
 347
 348 * `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: ''.
 349
 350 * `version`: Tells Apt to prefer a specified package version or version range. Valid options: a string. Default: ''.
 351
 352 #### Define: `apt::ppa`
 353
 354 Manages PPA repositories using `add-apt-repository`. Not supported on Debian.
 355
 356 ##### Parameters (all optional, except where specified)
 357
 358 * `ensure`: Specifies whether the PPA should exist. Valid options: 'present' and 'absent'. Default: 'present'.
 359
 360 * `options`: Supplies options to be passed to the `add-apt-repository` command. Valid options: a string. Defaults:
 361
 362   * Lucid: undef
 363   * All others: '-y'
 364
 365 * `package_manage`: Specifies whether Puppet should manage the package that provides `apt-add-repository`. Valid options: 'true' and 'false'. Default: 'false'.
 366
 367 * `package_name`: Names the package that provides the `apt-add-repository` command. Valid options: a string. Defaults:
 368
 369   * Lucid and Precise: 'python-software-properties'
 370   * Trusty, Utopic, and Vivid: 'software-properties-common'
 371   * All others: undef
 372
 373 * `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".
 374
 375 #### Define: `apt:setting`
 376
 377 Manages Apt configuration files.
 378
 379 ##### Parameters
 380
 381 * `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.
 382
 383 * `ensure`: Specifies whether the file should exist. Valid options: 'present', 'absent', and 'file'. Default: 'file'.
 384
 385 * `notify_update`: *Optional.* Specifies whether to trigger an `apt-get update` run. Valid options: 'true' and 'false'. Default: 'true'.
 386
 387 * `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.
 388
 389 * `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.
 390
 391 #### Define: `apt::source`
 392
 393 Manages the Apt sources in `/etc/apt/sources.list.d/`.
 394
 395 ##### Parameters (all optional, except where specified)
 396
 397 * `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'.
 398
 399 * `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).
 400
 401 * `comment`: Supplies a comment for adding to the Apt source file. Valid options: a string. Default: $name.
 402
 403 * `ensure`: Specifies whether the Apt source file should exist. Valid options: 'present' and 'absent'. Default: 'present'.
 404
 405 * `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.
 406
 407 * `include`: Configures include options. Valid options: a hash made up from the following keys:
 408
 409 * 'deb' - Specifies whether to request the distribution's compiled binaries. Valid options: 'true' and 'false. Default: 'true'.
 410
 411 * 'src' - Specifies whether to request the distribution's uncompiled source code. Valid options: 'true' and 'false'. Default: 'false'. Default: {}.
 412
 413 * `location`: *Required, unless `ensure` is set to 'absent'.* Specifies an Apt repository. Valid options: a string containing a repository URL. Default: undef.
 414
 415 * `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.
 416
 417 * `release`: Specifies a distribution of the Apt repository. Valid options: a string. Default: "$lsbdistcodename".
 418
 419 * `repos`: Specifies a component of the Apt repository. Valid options: a string. Default: 'main'.
 420
 421 #### Type: `apt_key`
 422
 423 Manages the GPG keys that Apt uses to authenticate packages.
 424
 425 **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.
 426
 427 ##### Parameters (all optional)
 428
 429 * `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.
 430
 431 * `options`: Passes additional options to `apt-key adv --keyserver-options`. Valid options: a string. Default: undef.
 432
 433 * `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'.
 434
 435 * `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.
 436
 437 ## Limitations
 438
 439 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.
 440
 441 ## Development
 442 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.
 443
 444 For more information, see our [module contribution guide.](https://docs.puppetlabs.com/forge/contributing.html)
 445
 446 To see who's already involved, see the [list of contributors.](https://github.com/puppetlabs/puppetlabs-apt/graphs/contributors)