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 generates a `Notice` message. Because the default [logging level for agents](https://docs.puppet.com/puppet/latest/configuration.html#loglevel) is `notice`, this causes 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. To eliminate these updates from reports, set the [loglevel](https://docs.puppet.com/puppet/latest/metaparameter.html#loglevel) metaparameter for `Exec['apt_update']` above the agent logging level:
  95
  96 ```puppet
  97 class { 'apt':
  98   update => {
  99     frequency => 'daily',
 100     loglevel  => 'debug',
 101   },
 102 }
 103 ```
 104
 105 ### Pin a specific release
 106
 107 ```puppet
 108 apt::pin { 'karmic': priority => 700 }
 109 apt::pin { 'karmic-updates': priority => 700 }
 110 apt::pin { 'karmic-security': priority => 700 }
 111 ```
 112
 113 You can also specify more complex pins using distribution properties:
 114
 115 ```puppet
 116 apt::pin { 'stable':
 117   priority        => -10,
 118   originator      => 'Debian',
 119   release_version => '3.0',
 120   component       => 'main',
 121   label           => 'Debian'
 122 }
 123 ```
 124
 125 To pin multiple packages, pass them to the `packages` parameter as an array or a space-delimited string.
 126
 127 ### Add a Personal Package Archive repository
 128
 129 ```puppet
 130 apt::ppa { 'ppa:drizzle-developers/ppa': }
 131 ```
 132
 133 ### Add an Apt source to `/etc/apt/sources.list.d/`
 134
 135 ```puppet
 136 apt::source { 'debian_unstable':
 137   comment  => 'This is the iWeb Debian unstable mirror',
 138   location => 'http://debian.mirror.iweb.ca/debian/',
 139   release  => 'unstable',
 140   repos    => 'main contrib non-free',
 141   pin      => '-10',
 142   key      => {
 143     'id'     => 'A1BD8E9D78F7FE5C3E65D8AF8B48AD6246925553',
 144     'server' => 'subkeys.pgp.net',
 145   },
 146   include  => {
 147     'src' => true,
 148     'deb' => true,
 149   },
 150 }
 151 ```
 152
 153 To use the Puppet Labs Apt repository as a source:
 154
 155 ```puppet
 156 apt::source { 'puppetlabs':
 157   location => 'http://apt.puppetlabs.com',
 158   repos    => 'main',
 159   key      => {
 160     'id'     => '6F6B15509CF8E59E6E469F327F438280EF8D349F',
 161     'server' => 'pgp.mit.edu',
 162   },
 163 }
 164 ```
 165
 166 ### Configure Apt from Hiera
 167
 168 Instead of specifying your sources directly as resources, you can instead just
 169 include the `apt` class, which will pick up the values automatically from
 170 hiera.
 171
 172 ```yaml
 173 apt::sources:
 174   'debian_unstable':
 175     comment: 'This is the iWeb Debian unstable mirror'
 176     location: 'http://debian.mirror.iweb.ca/debian/'
 177     release: 'unstable'
 178     repos: 'main contrib non-free'
 179     pin: '-10'
 180     key:
 181       id: 'A1BD8E9D78F7FE5C3E65D8AF8B48AD6246925553'
 182       server: 'subkeys.pgp.net'
 183     include:
 184       src: true
 185       deb: true
 186
 187   'puppetlabs':
 188     location: 'http://apt.puppetlabs.com'
 189     repos: 'main'
 190     key:
 191       id: '6F6B15509CF8E59E6E469F327F438280EF8D349F'
 192       server: 'pgp.mit.edu'
 193 ```
 194
 195 ### Replace the default sources.list file
 196
 197 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.
 198
 199 ```puppet
 200 apt::source { "archive.ubuntu.com-${lsbdistcodename}":
 201   location => 'http://archive.ubuntu.com/ubuntu',
 202   key      => '630239CC130E1A7FD81A27B140976EAF437D05B5',
 203   repos    => 'main universe multiverse restricted',
 204 }
 205
 206 apt::source { "archive.ubuntu.com-${lsbdistcodename}-security":
 207   location => 'http://archive.ubuntu.com/ubuntu',
 208   key      => '630239CC130E1A7FD81A27B140976EAF437D05B5',
 209   repos    => 'main universe multiverse restricted',
 210   release  => "${lsbdistcodename}-security"
 211 }
 212
 213 apt::source { "archive.ubuntu.com-${lsbdistcodename}-updates":
 214   location => 'http://archive.ubuntu.com/ubuntu',
 215   key      => '630239CC130E1A7FD81A27B140976EAF437D05B5',
 216   repos    => 'main universe multiverse restricted',
 217   release  => "${lsbdistcodename}-updates"
 218 }
 219
 220 apt::source { "archive.ubuntu.com-${lsbdistcodename}-backports":
 221  location => 'http://archive.ubuntu.com/ubuntu',
 222  key      => '630239CC130E1A7FD81A27B140976EAF437D05B5',
 223  repos    => 'main universe multiverse restricted',
 224  release  => "${lsbdistcodename}-backports"
 225 }
 226 ```
 227
 228 ## Reference
 229
 230 ### Classes
 231
 232 #### Public Classes
 233
 234 * [`apt`](#class-apt)
 235 * [`apt::backports`](#class-aptbackports)
 236
 237 #### Private Classes
 238
 239 * `apt::params`: Provides defaults for the apt module parameters.
 240 * `apt::update`: Updates the list of available packages using `apt-get update`.
 241
 242 ### Defined Types
 243
 244 * [`apt::conf`](#defined-type-aptconf)
 245 * [`apt::key`](#defined-type-aptkey)
 246 * [`apt::pin`](#defined-type-aptpin)
 247 * [`apt::ppa`](#defined-type-aptppa)
 248 * [`apt::setting`](#defined-type-aptsetting)
 249 * [`apt::source`](#defined-type-aptsource)
 250
 251 ### Types
 252
 253 * [`apt_key`](#type-apt_key)
 254
 255 ### Facts
 256
 257 * `apt_updates`: The number of installed packages with available updates.
 258
 259 * `apt_security_updates`: The number of installed packages with available security updates.
 260
 261 * `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.
 262
 263 * `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).
 264
 265 * `apt_reboot_required`: Determines if a reboot is necessary after updates have been installed.
 266
 267 #### Class: `apt`
 268
 269 Main class, includes all other classes.
 270
 271 ##### Parameters (all optional)
 272
 273 * `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: {}.
 274
 275 * `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: {}.
 276
 277 * `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: {}.
 278
 279 * `proxy`: Configures Apt to connect to a proxy server. Valid options: a hash made up from the following keys:
 280
 281   * 'host': Specifies a proxy host to be stored in `/etc/apt/apt.conf.d/01proxy`. Valid options: a string containing a hostname. Default: undef.
 282
 283   * '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.
 284
 285   * 'https': Specifies whether to enable https proxies. Valid options: 'true' and 'false'. Default: 'false'.
 286
 287   * 'ensure': Optional parameter. Valid options: 'file', 'present', and 'absent'. Default: 'undef'. Prefer 'file' over 'present'.
 288
 289 * `purge`: Specifies whether to purge any existing settings that aren't managed by Puppet. Valid options: a hash made up from the following keys:
 290
 291   * 'sources.list': Specifies whether to purge any unmanaged entries from `sources.list`. Valid options: 'true' and 'false'. Default: 'false'.
 292
 293   * 'sources.list.d': Specifies whether to purge any unmanaged entries from `sources.list.d`. Valid options: 'true' and 'false'. Default: 'false'.
 294
 295   * 'preferences': Specifies whether to purge any unmanaged entries from `preferences`. Valid options: 'true' and 'false'. Default: 'false'.
 296
 297   * 'preferences.d': Specifies whether to purge any unmanaged entries from `preferences.d`. Valid options: 'true' and 'false'. Default: 'false'.
 298
 299 * `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: {}.
 300
 301 * `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: {}.
 302
 303 * `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: {}.
 304
 305 * `update`: Configures various update settings. Valid options: a hash made up from the following keys:
 306
 307   * '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'.
 308
 309   * 'timeout': Specifies how long to wait for the update to complete before canceling it. Valid options: an integer, in seconds. Default: 300.
 310
 311   * 'tries': Specifies how many times to retry the update after receiving a DNS or HTTP error. Valid options: an integer. Default: 1.
 312
 313 #### Class: `apt::backports`
 314
 315 Manages backports.
 316
 317 ##### Parameters (all optional on Debian and Ubuntu; all required on other operating systems, except where specified)
 318
 319 * `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:
 320
 321   * Debian: 'A1BD8E9D78F7FE5C3E65D8AF8B48AD6246925553'
 322   * Ubuntu: '630239CC130E1A7FD81A27B140976EAF437D05B5'
 323
 324 * `location`: Specifies an Apt repository containing the backports to manage. Valid options: a string containing a URL. Defaults:
 325
 326   * Debian: 'http://deb.debian.org/debian'
 327   * Ubuntu: 'http://archive.ubuntu.com/ubuntu'
 328
 329 * `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'.
 330
 331 * `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.
 332
 333 * `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:
 334
 335   * Debian: 'main contrib non-free'
 336   * Ubuntu: 'main universe multiverse restricted'
 337
 338 #### Defined Type: `apt::conf`
 339
 340 Specifies a custom Apt configuration file.
 341
 342 ##### Parameters
 343
 344 * `content`: *Required, unless `ensure` is set to 'absent'.* Directly supplies content for the configuration file. Valid options: a string. Default: undef.
 345
 346 * `ensure`: Specifies whether the configuration file should exist. Valid options: 'present' and 'absent'. Default: 'present'.
 347
 348 * `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'.
 349
 350 * `notify_update`: *Optional.* Specifies whether to trigger an `apt-get update` run. Valid options: 'true' and 'false'. Default: 'true'.
 351
 352 #### Defined Type: `apt::key`
 353
 354 Manages the GPG keys that Apt uses to authenticate packages.
 355
 356 The `apt::key` defined type makes use of the `apt_key` type, but includes extra functionality to help prevent duplicate keys.
 357
 358 ##### Parameters (all optional)
 359
 360 * `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.
 361
 362 * `ensure`: Specifies whether the key should exist. Valid options: 'present' and 'absent'. Default: 'present'.
 363
 364 * `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.
 365
 366 * `options`: Passes additional options to `apt-key adv --keyserver-options`. Valid options: a string. Default: undef.
 367
 368 * `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.
 369
 370 * `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'.
 371
 372 #### Defined Type: `apt::pin`
 373
 374 Manages Apt pins. Does not trigger an `apt-get update` run.
 375
 376 **Note:** For context on these parameters, we recommend reading the man page ['apt_preferences(5)'](http://linux.die.net/man/5/apt_preferences)
 377
 378 ##### Parameters (all optional)
 379
 380 * `codename`: Specifies the distribution (lsbdistcodename) of the Apt repository. Valid options: a string. Default: ''.
 381
 382 * `component`: Names the licensing component associated with the packages in the directory tree of the Release file. Valid options: a string. Default: ''.
 383
 384 * `ensure`: Specifies whether the pin should exist. Valid options: 'file', 'present', and 'absent'. Default: 'present'.
 385
 386 * `explanation`: Supplies a comment to explain the pin. Valid options: a string. Default: "${caller_module_name}: ${name}".
 387
 388 * `label`: Names the label of the packages in the directory tree of the Release file. Valid options: a string (most commonly, 'debian'). Default: ''.
 389
 390 * `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.
 391
 392 * `origin`: Tells Apt to prefer packages from the specified server. Valid options: a string containing a hostname. Default: ''.
 393
 394 * `originator`: Names the originator of the packages in the directory tree of the Release file. Valid options: a string (most commonly, 'debian'). Default: ''.
 395
 396 * `packages`: Specifies which package(s) to pin. Valid options: a string or an array. Default: '*'.
 397
 398 * `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.
 399
 400 * `release`: Tells Apt to prefer packages that support the specified release. Typical values include 'stable', 'testing', and 'unstable' Valid options: a string. Default: ''.
 401
 402 * `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: ''.
 403
 404 * `version`: Tells Apt to prefer a specified package version or version range. Valid options: a string. Default: ''.
 405
 406 #### Defined Type: `apt::ppa`
 407
 408 Manages PPA repositories using `add-apt-repository`. Not supported on Debian.
 409
 410 ##### Parameters (all optional, except where specified)
 411
 412 * `ensure`: Specifies whether the PPA should exist. Valid options: 'present' and 'absent'. Default: 'present'.
 413
 414 * `options`: Supplies options to be passed to the `add-apt-repository` command. Valid options: a string. Defaults:
 415
 416   * Lucid: undef
 417   * All others: '-y'
 418
 419 * `package_manage`: Specifies whether Puppet should manage the package that provides `apt-add-repository`. Valid options: 'true' and 'false'. Default: 'false'.
 420
 421 * `package_name`: Names the package that provides the `apt-add-repository` command. Valid options: a string. Defaults:
 422
 423   * Lucid and Precise: 'python-software-properties'
 424   * Trusty and newer: 'software-properties-common'
 425   * All others: 'python-software-properties'
 426
 427 * `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".
 428
 429 #### Defined Type: `apt::setting`
 430
 431 Manages Apt configuration files.
 432
 433 ##### Parameters
 434
 435 * `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.
 436
 437 * `ensure`: Specifies whether the file should exist. Valid options: 'present', 'absent', and 'file'. Default: 'file'.
 438
 439 * `notify_update`: *Optional.* Specifies whether to trigger an `apt-get update` run. Valid options: 'true' and 'false'. Default: 'true'.
 440
 441 * `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.
 442
 443 * `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.
 444
 445 #### Defined Type: `apt::source`
 446
 447 Manages the Apt sources in `/etc/apt/sources.list.d/`.
 448
 449 ##### Parameters (all optional, except where specified)
 450
 451 * `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'.
 452
 453 * `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).
 454
 455 * `comment`: Supplies a comment for adding to the Apt source file. Valid options: a string. Default: $name.
 456
 457 * `ensure`: Specifies whether the Apt source file should exist. Valid options: 'present' and 'absent'. Default: 'present'.
 458
 459 * `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.
 460
 461 * `include`: Configures include options. Valid options: a hash of available keys. Default: {}. Available keys are:
 462
 463   * 'deb' - Specifies whether to request the distribution's compiled binaries. Valid options: 'true' and 'false'. Default: 'true'.
 464
 465   * 'src' - Specifies whether to request the distribution's uncompiled source code. Valid options: 'true' and 'false'. Default: 'false'.
 466
 467 * `location`: *Required, unless `ensure` is set to 'absent'.* Specifies an Apt repository. Valid options: a string containing a repository URL. Default: undef.
 468
 469 * `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.
 470
 471 * `release`: Specifies a distribution of the Apt repository. Valid options: a string. Default: "$lsbdistcodename".
 472
 473   * `repos`: Specifies a component of the Apt repository. Valid options: a string. Default: 'main'.
 474
 475 * `notify_update`: *Optional.* Specifies whether to trigger an `apt-get update` run. Valid options: 'true' and 'false'. Default: 'true'.
 476
 477 #### Type: `apt_key`
 478
 479 Manages the GPG keys that Apt uses to authenticate packages.
 480
 481 **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.
 482
 483 ##### Parameters (all optional)
 484
 485 * `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.
 486
 487 * `options`: Passes additional options to `apt-key adv --keyserver-options`. Valid options: a string. Default: undef.
 488
 489 * `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'.
 490
 491 * `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.
 492
 493 ## Limitations
 494
 495 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.
 496
 497 This module is not designed to be split across [run stages](https://docs.puppetlabs.com/puppet/latest/reference/lang_run_stages.html).
 498
 499 ### Adding new sources or PPAs
 500
 501 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).
 502
 503 ```puppet
 504 Class['apt::update'] -> Package <| provider == 'apt' |>
 505 ```
 506
 507 ## Development
 508 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.
 509
 510 For more information, see our [module contribution guide.](https://docs.puppetlabs.com/forge/contributing.html)
 511
 512 To see who's already involved, see the [list of contributors.](https://github.com/puppetlabs/puppetlabs-apt/graphs/contributors)