README.md

   1 # apt
   2
   3 #### Table of Contents
   4
   5
   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     * [Add GPG keys](#add-gpg-keys)
  12     * [Prioritize backports](#prioritize-backports)
  13     * [Update the list of packages](#update-the-list-of-packages)
  14     * [Pin a specific release](#pin-a-specific-release)
  15     * [Add a Personal Package Archive repository](#add-a-personal-package-archive-repository)
  16     * [Configure Apt from Hiera](#configure-apt-from-hiera)
  17     * [Replace the default sources.list file](#replace-the-default-sourceslist-file)
  18 5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
  19     * [Classes](#classes)
  20     * [Defined Types](#defined-types)
  21     * [Types](#types)
  22     * [Facts](#facts)
  23 6. [Limitations - OS compatibility, etc.](#limitations)
  24 7. [Development - Guide for contributing to the module](#development)
  25
  26 ## Module Description
  27
  28 The apt module lets you use Puppet to manage Apt sources, keys, and other configuration options.
  29
  30 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.
  31
  32 **Note**: For this module to correctly autodetect which version of Debian/Ubuntu (or derivative) you're running, you need to make sure the 'lsb-release' package is installed. We highly recommend you either make this part of your provisioning layer, if you run many Debian or derivative systems, or ensure that you have Facter 2.2.0 or later installed, which will pull this dependency in for you.
  33
  34 ## Setup
  35
  36 ### What apt affects
  37
  38 * Your system's `preferences` file and `preferences.d` directory
  39 * Your system's `sources.list` file and `sources.list.d` directory
  40 * System repositories
  41 * Authentication keys
  42
  43 **Note:** This module offers `purge` parameters which, if set to 'true', **destroy** any configuration on the node's `sources.list(.d)` and `preferences(.d)` that you haven't declared through Puppet. The default for these parameters is 'false'.
  44
  45 ### Beginning with apt
  46
  47 To use the apt module with default parameters, declare the `apt` class.
  48
  49 ```puppet
  50 include apt
  51 ```
  52
  53 **Note:** The main `apt` class is required by all other classes, types, and defined types in this module. You must declare it whenever you use the module.
  54
  55 ## Usage
  56
  57 ### Add GPG keys
  58
  59 **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.
  60
  61 Declare the `apt::key` defined type:
  62
  63 ```puppet
  64 apt::key { 'puppetlabs':
  65   id      => '6F6B15509CF8E59E6E469F327F438280EF8D349F',
  66   server  => 'pgp.mit.edu',
  67   options => 'http-proxy="http://proxyuser:proxypass@example.org:3128"',
  68 }
  69 ```
  70
  71 ### Prioritize backports
  72
  73 ```puppet
  74 class { 'apt::backports':
  75   pin => 500,
  76 }
  77 ```
  78
  79 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.
  80
  81 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.
  82
  83 ### Update the list of packages
  84
  85 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':
  86
  87 ```puppet
  88 class { 'apt':
  89   update => {
  90     frequency => 'daily',
  91   },
  92 }
  93 ```
  94 When `Exec['apt_update']` is triggered, it will generate a `Notice` message. Because the default [logging level for agents](https://docs.puppet.com/puppet/latest/configuration.html#loglevel) is `notice`, this will cause the repository update to appear in logs and agent reports. Some tools, such as [The Foreman](https://www.theforeman.org), report the update notice as a significant change. By setting the [loglevel](https://docs.puppet.com/puppet/latest/metaparameter.html#loglevel) metaparameter for `Exec['apt_update']` above the agent logging level, one can eliminate these updates from reports:
  95 ```puppet
  96 class { 'apt':
  97   update => {
  98     frequency => 'daily',
  99     loglevel  => 'debug',
 100   },
 101 }
 102 ```
 103
 104 ### Pin a specific release
 105
 106 ```puppet
 107 apt::pin { 'karmic': priority => 700 }
 108 apt::pin { 'karmic-updates': priority => 700 }
 109 apt::pin { 'karmic-security': priority => 700 }
 110 ```
 111
 112 You can also specify more complex pins using distribution properties:
 113
 114 ```puppet
 115 apt::pin { 'stable':
 116   priority        => -10,
 117   originator      => 'Debian',
 118   release_version => '3.0',
 119   component       => 'main',
 120   label           => 'Debian'
 121 }
 122 ```
 123
 124 To pin multiple packages, pass them to the `packages` parameter as an array or a space-delimited string.
 125
 126 ### Add a Personal Package Archive repository
 127
 128 ```puppet
 129 apt::ppa { 'ppa:drizzle-developers/ppa': }
 130 ```
 131
 132 ### Add an Apt source to `/etc/apt/sources.list.d/`
 133
 134 ```puppet
 135 apt::source { 'debian_unstable':
 136   comment  => 'This is the iWeb Debian unstable mirror',
 137   location => 'http://debian.mirror.iweb.ca/debian/',
 138   release  => 'unstable',
 139   repos    => 'main contrib non-free',
 140   pin      => '-10',
 141   key      => {
 142     'id'     => 'A1BD8E9D78F7FE5C3E65D8AF8B48AD6246925553',
 143     'server' => 'subkeys.pgp.net',
 144   },
 145   include  => {
 146     'src' => true,
 147     'deb' => true,
 148   },
 149 }
 150 ```
 151
 152 To use the Puppet Labs Apt repository as a source:
 153
 154 ```puppet
 155 apt::source { 'puppetlabs':
 156   location => 'http://apt.puppetlabs.com',
 157   repos    => 'main',
 158   key      => {
 159     'id'     => '6F6B15509CF8E59E6E469F327F438280EF8D349F',
 160     'server' => 'pgp.mit.edu',
 161   },
 162 }
 163 ```
 164
 165 ### Configure Apt from Hiera
 166
 167 Instead of specifying your sources directly as resources, you can instead just
 168 include the `apt` class, which will pick up the values automatically from
 169 hiera.
 170
 171 ```yaml
 172 apt::sources:
 173   'debian_unstable':
 174     comment: 'This is the iWeb Debian unstable mirror'
 175     location: 'http://debian.mirror.iweb.ca/debian/'
 176     release: 'unstable'
 177     repos: 'main contrib non-free'
 178     pin: '-10'
 179     key:
 180       id: 'A1BD8E9D78F7FE5C3E65D8AF8B48AD6246925553'
 181       server: 'subkeys.pgp.net'
 182     include:
 183       src: true
 184       deb: true
 185
 186   'puppetlabs':
 187     location: 'http://apt.puppetlabs.com'
 188     repos: 'main'
 189     key:
 190       id: '6F6B15509CF8E59E6E469F327F438280EF8D349F'
 191       server: 'pgp.mit.edu'
 192 ```
 193
 194 ### Replace the default sources.list file
 195
 196 The following example replaces the default `/etc/apt/sources.list`. Along with this code, be sure to use the `purge` parameter, or you might get duplicate source warnings when running Apt.
 197
 198 ```puppet
 199 apt::source { "archive.ubuntu.com-${lsbdistcodename}":
 200   location => 'http://archive.ubuntu.com/ubuntu',
 201   key      => '630239CC130E1A7FD81A27B140976EAF437D05B5',
 202   repos    => 'main universe multiverse restricted',
 203 }
 204
 205 apt::source { "archive.ubuntu.com-${lsbdistcodename}-security":
 206   location => 'http://archive.ubuntu.com/ubuntu',
 207   key      => '630239CC130E1A7FD81A27B140976EAF437D05B5',
 208   repos    => 'main universe multiverse restricted',
 209   release  => "${lsbdistcodename}-security"
 210 }
 211
 212 apt::source { "archive.ubuntu.com-${lsbdistcodename}-updates":
 213   location => 'http://archive.ubuntu.com/ubuntu',
 214   key      => '630239CC130E1A7FD81A27B140976EAF437D05B5',
 215   repos    => 'main universe multiverse restricted',
 216   release  => "${lsbdistcodename}-updates"
 217 }
 218
 219 apt::source { "archive.ubuntu.com-${lsbdistcodename}-backports":
 220  location => 'http://archive.ubuntu.com/ubuntu',
 221  key      => '630239CC130E1A7FD81A27B140976EAF437D05B5',
 222  repos    => 'main universe multiverse restricted',
 223  release  => "${lsbdistcodename}-backports"
 224 }
 225 ```
 226
 227 ## Reference
 228
 229 ### Classes
 230
 231 #### Public Classes
 232
 233 * [`apt`](#class-apt)
 234 * [`apt::backports`](#class-aptbackports)
 235
 236 #### Private Classes
 237
 238 * `apt::params`: Provides defaults for the apt module parameters.
 239 * `apt::update`: Updates the list of available packages using `apt-get update`.
 240
 241 ### Defined Types
 242
 243 * [`apt::conf`](#defined-type-aptconf)
 244 * [`apt::key`](#defined-type-aptkey)
 245 * [`apt::pin`](#defined-type-aptpin)
 246 * [`apt::ppa`](#defined-type-aptppa)
 247 * [`apt::setting`](#defined-type-aptsetting)
 248 * [`apt::source`](#defined-type-aptsource)
 249
 250 ### Types
 251
 252 * [`apt_key`](#type-apt_key)
 253
 254 ### Facts
 255
 256 * `apt_updates`: The number of installed packages with available updates.
 257
 258 * `apt_security_updates`: The number of installed packages with available security updates.
 259
 260 * `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.
 261
 262 * `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).
 263
 264 * `apt_reboot_required`: Determines if a reboot is necessary after updates have been installed.
 265
 266 #### Class: `apt`
 267
 268 Main class, includes all other classes.
 269
 270 ##### Parameters (all optional)
 271
 272 * `confs`: Creates new `apt::conf` resources. Valid options: a hash to be passed to the [`create_resources` function](https://docs.puppetlabs.com/references/latest/function.html#createresources). Default: {}.
 273
 274 * `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: {}.
 275
 276 * `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: {}.
 277
 278 * `proxy`: Configures Apt to connect to a proxy server. Valid options: a hash made up from the following keys:
 279
 280   * 'host': Specifies a proxy host to be stored in `/etc/apt/apt.conf.d/01proxy`. Valid options: a string containing a hostname. Default: undef.
 281
 282   * 'port': Specifies a proxy port to be stored in `/etc/apt/apt.conf.d/01proxy`. Valid options: an integer containing a port number. Default: 8080.
 283
 284   * 'https': Specifies whether to enable https proxies. Valid options: 'true' and 'false'. Default: 'false'.
 285
 286   * 'ensure': Optional parameter. Valid options: 'file', 'present', and 'absent'. Default: 'undef'. Prefer 'file' over 'present'.
 287
 288 * `purge`: Specifies whether to purge any existing settings that aren't managed by Puppet. Valid options: a hash made up from the following keys:
 289
 290   * 'sources.list': Specifies whether to purge any unmanaged entries from `sources.list`. Valid options: 'true' and 'false'. Default: 'false'.
 291
 292   * 'sources.list.d': Specifies whether to purge any unmanaged entries from `sources.list.d`. Valid options: 'true' and 'false'. Default: 'false'.
 293
 294   * 'preferences': Specifies whether to purge any unmanaged entries from `preferences`. Valid options: 'true' and 'false'. Default: 'false'.
 295
 296   * 'preferences.d': Specifies whether to purge any unmanaged entries from `preferences.d`. Valid options: 'true' and 'false'. Default: 'false'.
 297
 298 * `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: {}.
 299
 300 * `sources`: Creates new `apt::source` resources. Valid options: a hash to be passed to the [`create_resources` function](https://docs.puppetlabs.com/references/latest/function.html#createresources). Default: {}.
 301
 302 * `pins`: Creates new `apt::pin` resources. Valid options: a hash to be passed to the [`create_resources` function](https://docs.puppetlabs.com/references/latest/function.html#createresources). Default: {}.
 303
 304 * `update`: Configures various update settings. Valid options: a hash made up from the following keys:
 305
 306   * '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'.
 307
 308   * 'timeout': Specifies how long to wait for the update to complete before canceling it. Valid options: an integer, in seconds. Default: 300.
 309
 310   * 'tries': Specifies how many times to retry the update after receiving a DNS or HTTP error. Valid options: an integer. Default: 1.
 311
 312 #### Class: `apt::backports`
 313
 314 Manages backports.
 315
 316 ##### Parameters (all optional on Debian and Ubuntu; all required on other operating systems, except where specified)
 317
 318 * `key`: Specifies a key to authenticate the backports. Valid options: a string to be passed to the `id` parameter of the `apt::key` defined type, or a hash of `parameter => value` pairs to be passed to `apt::key`'s `id`, `server`, `content`, `source`, and/or `options` parameters. Defaults:
 319
 320   * Debian: 'A1BD8E9D78F7FE5C3E65D8AF8B48AD6246925553'
 321   * Ubuntu: '630239CC130E1A7FD81A27B140976EAF437D05B5'
 322
 323 * `location`: Specifies an Apt repository containing the backports to manage. Valid options: a string containing a URL. Defaults:
 324
 325   * Debian: 'http://deb.debian.org/debian'
 326   * Ubuntu: 'http://archive.ubuntu.com/ubuntu'
 327
 328 * `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` defined type, or a hash of `parameter => value` pairs to be passed to `apt::pin`'s corresponding parameters. Default: '200'.
 329
 330 * `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.
 331
 332 * `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:
 333
 334   * Debian: 'main contrib non-free'
 335   * Ubuntu: 'main universe multiverse restricted'
 336
 337 #### Defined Type: `apt::conf`
 338
 339 Specifies a custom Apt configuration file.
 340
 341 ##### Parameters
 342
 343 * `content`: *Required, unless `ensure` is set to 'absent'.* Directly supplies content for the configuration file. Valid options: a string. Default: undef.
 344
 345 * `ensure`: Specifies whether the configuration file should exist. Valid options: 'present' and 'absent'. Default: 'present'.
 346
 347 * `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'.
 348
 349 * `notify_update`: *Optional.* Specifies whether to trigger an `apt-get update` run. Valid options: 'true' and 'false'. Default: 'true'.
 350
 351 #### Defined Type: `apt::key`
 352
 353 Manages the GPG keys that Apt uses to authenticate packages.
 354
 355 The `apt::key` defined type makes use of the `apt_key` type, but includes extra functionality to help prevent duplicate keys.
 356
 357 ##### Parameters (all optional)
 358
 359 * `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.
 360
 361 * `ensure`: Specifies whether the key should exist. Valid options: 'present' and 'absent'. Default: 'present'.
 362
 363 * `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.
 364
 365 * `options`: Passes additional options to `apt-key adv --keyserver-options`. Valid options: a string. Default: undef.
 366
 367 * `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.
 368
 369 * `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'.
 370
 371 #### Defined Type: `apt::pin`
 372
 373 Manages Apt pins. Does not trigger an `apt-get update` run.
 374
 375 **Note:** For context on these parameters, we recommend reading the man page ['apt_preferences(5)'](http://linux.die.net/man/5/apt_preferences)
 376
 377 ##### Parameters (all optional)
 378
 379 * `codename`: Specifies the distribution (lsbdistcodename) of the Apt repository. Valid options: a string. Default: ''.
 380
 381 * `component`: Names the licensing component associated with the packages in the directory tree of the Release file. Valid options: a string. Default: ''.
 382
 383 * `ensure`: Specifies whether the pin should exist. Valid options: 'file', 'present', and 'absent'. Default: 'present'.
 384
 385 * `explanation`: Supplies a comment to explain the pin. Valid options: a string. Default: "${caller_module_name}: ${name}".
 386
 387 * `label`: Names the label of the packages in the directory tree of the Release file. Valid options: a string (most commonly, 'debian'). Default: ''.
 388
 389 * `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.
 390
 391 * `origin`: Tells Apt to prefer packages from the specified server. Valid options: a string containing a hostname. Default: ''.
 392
 393 * `originator`: Names the originator of the packages in the directory tree of the Release file. Valid options: a string (most commonly, 'debian'). Default: ''.
 394
 395 * `packages`: Specifies which package(s) to pin. Valid options: a string or an array. Default: '*'.
 396
 397 * `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.
 398
 399 * `release`: Tells Apt to prefer packages that support the specified release. Typical values include 'stable', 'testing', and 'unstable' Valid options: a string. Default: ''.
 400
 401 * `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: ''.
 402
 403 * `version`: Tells Apt to prefer a specified package version or version range. Valid options: a string. Default: ''.
 404
 405 #### Defined Type: `apt::ppa`
 406
 407 Manages PPA repositories using `add-apt-repository`. Not supported on Debian.
 408
 409 ##### Parameters (all optional, except where specified)
 410
 411 * `ensure`: Specifies whether the PPA should exist. Valid options: 'present' and 'absent'. Default: 'present'.
 412
 413 * `options`: Supplies options to be passed to the `add-apt-repository` command. Valid options: a string. Defaults:
 414
 415   * Lucid: undef
 416   * All others: '-y'
 417
 418 * `package_manage`: Specifies whether Puppet should manage the package that provides `apt-add-repository`. Valid options: 'true' and 'false'. Default: 'false'.
 419
 420 * `package_name`: Names the package that provides the `apt-add-repository` command. Valid options: a string. Defaults:
 421
 422   * Lucid and Precise: 'python-software-properties'
 423   * Trusty and newer: 'software-properties-common'
 424   * All others: 'python-software-properties'
 425
 426 * `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".
 427
 428 #### Defined Type: `apt::setting`
 429
 430 Manages Apt configuration files.
 431
 432 ##### Parameters
 433
 434 * `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.
 435
 436 * `ensure`: Specifies whether the file should exist. Valid options: 'present', 'absent', and 'file'. Default: 'file'.
 437
 438 * `notify_update`: *Optional.* Specifies whether to trigger an `apt-get update` run. Valid options: 'true' and 'false'. Default: 'true'.
 439
 440 * `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.
 441
 442 * `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.
 443
 444 #### Defined Type: `apt::source`
 445
 446 Manages the Apt sources in `/etc/apt/sources.list.d/`.
 447
 448 ##### Parameters (all optional, except where specified)
 449
 450 * `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'.
 451
 452 * `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).
 453
 454 * `comment`: Supplies a comment for adding to the Apt source file. Valid options: a string. Default: $name.
 455
 456 * `ensure`: Specifies whether the Apt source file should exist. Valid options: 'present' and 'absent'. Default: 'present'.
 457
 458 * `key`: Creates a declaration of the apt::key defined type. Valid options: a string to be passed to the `id` parameter of the `apt::key` defined type, or a hash of `parameter => value` pairs to be passed to `apt::key`'s `id`, `server`, `content`, `source`, and/or `options` parameters. Default: undef.
 459
 460 * `include`: Configures include options. Valid options: a hash of available keys. Default: {}. Available keys are:
 461
 462   * 'deb' - Specifies whether to request the distribution's compiled binaries. Valid options: 'true' and 'false'. Default: 'true'.
 463
 464   * 'src' - Specifies whether to request the distribution's uncompiled source code. Valid options: 'true' and 'false'. Default: 'false'.
 465
 466 * `location`: *Required, unless `ensure` is set to 'absent'.* Specifies an Apt repository. Valid options: a string containing a repository URL. Default: undef.
 467
 468 * `pin`: Creates a declaration of the apt::pin defined type. Valid options: a number or string to be passed to the `id` parameter of the `apt::pin` defined type, or a hash of `parameter => value` pairs to be passed to `apt::pin`'s corresponding parameters. Default: undef.
 469
 470 * `release`: Specifies a distribution of the Apt repository. Valid options: a string. Default: "$lsbdistcodename".
 471
 472   * `repos`: Specifies a component of the Apt repository. Valid options: a string. Default: 'main'.
 473
 474 * `notify_update`: *Optional.* Specifies whether to trigger an `apt-get update` run. Valid options: 'true' and 'false'. Default: 'true'.
 475
 476 #### Type: `apt_key`
 477
 478 Manages the GPG keys that Apt uses to authenticate packages.
 479
 480 **Note:** In most cases, we recommend using the `apt::key` defined type. It makes use of the `apt_key` type, but includes extra functionality to help prevent duplicate keys.
 481
 482 ##### Parameters (all optional)
 483
 484 * `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.
 485
 486 * `options`: Passes additional options to `apt-key adv --keyserver-options`. Valid options: a string. Default: undef.
 487
 488 * `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'.
 489
 490 * `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.
 491
 492 ## Limitations
 493
 494 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.
 495
 496 This module is not designed to be split across [run stages](https://docs.puppetlabs.com/puppet/latest/reference/lang_run_stages.html).
 497
 498 ### Adding new sources or PPAs
 499
 500 If you are adding a new source or PPA and trying to install packages from the new source or PPA on the same Puppet run, your `package` resource should depend on `Class['apt::update']`, in addition to depending on the `Apt::Source` or the `Apt::Ppa`. You can also add [collectors](https://docs.puppetlabs.com/puppet/latest/reference/lang_collectors.html) to ensure that all packages happen after `apt::update`, but this can lead to dependency cycles and has implications for [virtual resources](https://docs.puppetlabs.com/puppet/latest/reference/lang_collectors.html#behavior).
 501
 502 ```puppet
 503 Class['apt::update'] -> Package <| provider == 'apt' |>
 504 ```
 505
 506 ## Development
 507 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.
 508
 509 For more information, see our [module contribution guide.](https://docs.puppetlabs.com/forge/contributing.html)
 510
 511 To see who's already involved, see the [list of contributors.](https://github.com/puppetlabs/puppetlabs-apt/graphs/contributors)