README.md

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