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