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