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