README.md

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