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 ### Manage login configuration settings for an APT source or proxy in `/etc/apt/auth.conf`
 230
 231 Starting with APT version 1.5, you can define login configuration settings, such as
 232 username and password, for APT sources or proxies that require authentication
 233 in the `/etc/apt/auth.conf` file. This is preferable to embedding login
 234 information directly in `source.list` entries, which are usually world-readable.
 235
 236 The `/etc/apt/auth.conf` file follows the format of netrc (used by ftp or
 237 curl) and has restrictive file permissions. See
 238 https://manpages.debian.org/testing/apt/apt_auth.conf.5.en.html for details.
 239
 240 Use the optional `apt::auth_conf_entries` parameter to specify an array of
 241 hashes containing login configuration settings. These hashes may only contain
 242 the `machine`, `login` and `password` keys.
 243
 244 ```puppet
 245 class { 'apt':
 246   auth_conf_entries => [
 247     {
 248       'machine'  => 'apt-proxy.example.net',
 249       'login'    => 'proxylogin',
 250       'password' => 'proxypassword',
 251     },
 252     {
 253       'machine'  => 'apt.example.com/ubuntu',
 254       'login'    => 'reader',
 255       'password' => 'supersecret',
 256     },
 257   ],
 258 }
 259 ```
 260
 261 ## Reference
 262
 263 ### Classes
 264
 265 #### Public Classes
 266
 267 * [`apt`](#class-apt)
 268 * [`apt::backports`](#class-aptbackports)
 269
 270 #### Private Classes
 271
 272 * `apt::params`: Provides defaults for the apt module parameters.
 273 * `apt::update`: Updates the list of available packages using `apt-get update`.
 274
 275 ### Defined Types
 276
 277 * [`apt::conf`](#defined-type-aptconf)
 278 * [`apt::key`](#defined-type-aptkey)
 279 * [`apt::pin`](#defined-type-aptpin)
 280 * [`apt::ppa`](#defined-type-aptppa)
 281 * [`apt::setting`](#defined-type-aptsetting)
 282 * [`apt::source`](#defined-type-aptsource)
 283 * [`apt::proxy`](#defined-type-aptproxy)
 284
 285 ### Types
 286
 287 * [`apt_key`](#type-apt_key)
 288
 289 ### Facts
 290
 291 * `apt_updates`: The number of installed packages with available updates from `upgrade`.
 292
 293 * `apt_dist_updates`: The number of installed packages with available updates from `dist-upgrade`.
 294
 295 * `apt_security_updates`: The number of installed packages with available security updates from `upgrade`.
 296
 297 * `apt_security_dist_updates`: The number of installed packages with available security updates from `dist-upgrade`.
 298
 299 * `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.
 300
 301 * `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.
 302
 303 * `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).
 304
 305 * `apt_reboot_required`: Determines if a reboot is necessary after updates have been installed.
 306
 307 ### Tasks
 308
 309 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.
 310
 311 #### Class: `apt`
 312
 313 Main class, includes all other classes.
 314
 315 ##### Parameters
 316
 317 All parameters are optional unless specified.
 318
 319 * `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: {}.
 320
 321 * `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: {}.
 322
 323 * `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: {}.
 324
 325 * `proxy`: Configures Apt to connect to a proxy server. Valid options: a hash matching the locally defined type [`apt::proxy`](#defined-type-aptproxy).
 326
 327 * `purge`: Specifies whether to purge any existing settings that aren't managed by Puppet. Valid options: a hash made up from the following keys:
 328
 329   * `sources.list`: Specifies whether to purge any unmanaged entries from `sources.list`. Valid options: `true` and `false`. Default: `false`.
 330
 331   * `sources.list.d`: Specifies whether to purge any unmanaged entries from `sources.list.d`. Valid options: `true` and `false`. Default: `false`.
 332
 333   * `preferences`: Specifies whether to purge any unmanaged entries from `preferences`. Valid options: `true` and `false`. Default: `false`.
 334
 335   * `preferences.d`: Specifies whether to purge any unmanaged entries from `preferences.d`. Valid options: `true` and `false`. Default: `false`.
 336
 337 * `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: {}.
 338
 339 * `auth_conf_entries`: An optional array of login configuration settings (hashes) that will be recorded in the file `/etc/apt/auth.conf`. This file has a netrc-like format (similar to what curl uses) and contains the login configuration for APT sources and proxies that require authentication. See https://manpages.debian.org/testing/apt/apt_auth.conf.5.en.html for details. If specified each hash must contain the keys `machine`, `login` and `password` and no others. Default: [].
 340
 341 * `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: {}.
 342
 343 * `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: {}.
 344
 345 * `update`: Configures various update settings. Valid options: a hash made up from the following keys:
 346
 347   * `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'.
 348
 349   * `timeout`: Specifies how long to wait for the update to complete before canceling it. Valid options: an integer, in seconds. Default: 300.
 350
 351   * `tries`: Specifies how many times to retry the update after receiving a DNS or HTTP error. Valid options: an integer. Default: 1.
 352
 353 #### Class: `apt::backports`
 354
 355 Manages backports.
 356
 357 ##### Parameters
 358
 359 All parameters are optional on Debian and Ubuntu and required on other operating systems, except where specified.
 360
 361 * `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:
 362
 363   * Debian: 'A1BD8E9D78F7FE5C3E65D8AF8B48AD6246925553'
 364   * Ubuntu: '630239CC130E1A7FD81A27B140976EAF437D05B5'
 365
 366 * `location`: Specifies an Apt repository containing the backports to manage. Valid options: a string containing a URL. Defaults:
 367
 368   * Debian: 'http://deb.debian.org/debian'
 369   * Ubuntu: 'http://archive.ubuntu.com/ubuntu'
 370
 371 * `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'.
 372
 373 * `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.
 374
 375 * `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:
 376
 377   * Debian: 'main contrib non-free'
 378   * Ubuntu: 'main universe multiverse restricted'
 379
 380 #### Defined Type: `apt::conf`
 381
 382 Specifies a custom Apt configuration file.
 383
 384 ##### Parameters
 385
 386 All parameters are optional unless specified.
 387
 388
 389 * `content`: *Required, unless `ensure` is set to 'absent'.* Directly supplies content for the configuration file. Valid options: a string. Default: undef.
 390
 391 * `ensure`: Specifies whether the configuration file should exist. Valid options: 'present' and 'absent'. Default: 'present'.
 392
 393 * `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'.
 394
 395 * `notify_update`: *Optional.* Specifies whether to trigger an `apt-get update` run. Valid options: `true` and `false`. Default: `true`.
 396
 397 #### Defined type: `apt::key`
 398
 399 Manages the GPG keys that Apt uses to authenticate packages.
 400
 401 The `apt::key` defined type makes use of the `apt_key` type, but includes extra functionality to help prevent duplicate keys.
 402
 403 ##### Parameters (all optional)
 404
 405 * `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.
 406
 407 * `ensure`: Specifies whether the key should exist. Valid options: 'present' and 'absent'. Default: 'present'.
 408
 409 * `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.
 410
 411 * `options`: Passes additional options to `apt-key adv --keyserver-options`. Valid options: a string. Default: undef.
 412
 413 * `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.
 414
 415 * `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'.
 416
 417 #### Defined type: `apt::pin`
 418
 419 Manages Apt pins. Does not trigger an `apt-get update` run.
 420
 421 **Note:** For context on these parameters, we recommend reading the man page ['apt_preferences(5)'](http://linux.die.net/man/5/apt_preferences)
 422
 423 ##### Parameters
 424
 425 All parameters are optional unless specified.
 426
 427 * `codename`: Specifies the distribution (lsbdistcodename) of the Apt repository. Valid options: a string. Default: ''.
 428
 429 * `component`: Names the licensing component associated with the packages in the directory tree of the Release file. Valid options: a string. Default: ''.
 430
 431 * `ensure`: Specifies whether the pin should exist. Valid options: 'file', 'present', and 'absent'. Default: 'present'.
 432
 433 * `explanation`: Supplies a comment to explain the pin. Valid options: a string. Default: "${caller_module_name}: ${name}".
 434
 435 * `label`: Names the label of the packages in the directory tree of the Release file. Valid options: a string (most commonly, 'debian'). Default: ''.
 436
 437 * `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.
 438
 439 * `origin`: Tells Apt to prefer packages from the specified server. Valid options: a string containing a hostname. Default: ''.
 440
 441 * `originator`: Names the originator of the packages in the directory tree of the Release file. Valid options: a string (most commonly, 'debian'). Default: ''.
 442
 443 * `packages`: Specifies which package(s) to pin. Valid options: a string or an array. Default: `*`.
 444
 445 * `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.
 446
 447 * `release`: Tells Apt to prefer packages that support the specified release. Typical values include 'stable', 'testing', and 'unstable' Valid options: a string. Default: ''.
 448
 449 * `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: ''.
 450
 451 * `version`: Tells Apt to prefer a specified package version or version range. Valid options: a string. Default: ''.
 452
 453 #### Defined Type: `apt::ppa`
 454
 455 Manages PPA repositories using `add-apt-repository`. Not supported on Debian.
 456
 457 ##### Parameters
 458
 459 All parameters are optional unless specified.
 460
 461 * `ensure`: Specifies whether the PPA should exist. Valid options: 'present' and 'absent'. Default: 'present'.
 462
 463 * `options`: Supplies options to be passed to the `add-apt-repository` command. Valid options: a string. Defaults:
 464
 465   * Lucid: undef
 466   * All others: '-y'
 467
 468 * `package_manage`: Specifies whether Puppet should manage the package that provides `apt-add-repository`. Valid options: `true` and `false`. Default: `false`.
 469
 470 * `package_name`: Names the package that provides the `apt-add-repository` command. Valid options: a string. Defaults:
 471
 472   * Lucid and Precise: 'python-software-properties'
 473   * Trusty and newer: 'software-properties-common'
 474   * All others: 'python-software-properties'
 475
 476 * `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".
 477
 478 #### Defined Type: `apt::setting`
 479
 480 Manages Apt configuration files.
 481
 482 ##### Parameters
 483
 484 All parameters are optional unless specified.
 485
 486 * `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.
 487
 488 * `ensure`: Specifies whether the file should exist. Valid options: 'present', 'absent', and 'file'. Default: 'file'.
 489
 490 * `notify_update`: *Optional.* Specifies whether to trigger an `apt-get update` run. Valid options: `true` and `false`. Default: `true`.
 491
 492 * `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.
 493
 494 * `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.
 495
 496 #### Defined Type: `apt::source`
 497
 498 Manages the Apt sources in `/etc/apt/sources.list.d/`.
 499
 500 ##### Parameters
 501
 502 All parameters are optional unless specified.
 503
 504 * `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`.
 505
 506 * `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).
 507
 508 * `comment`: Supplies a comment for adding to the Apt source file. Valid options: a string. Default: $name.
 509
 510 * `ensure`: Specifies whether the Apt source file should exist. Valid options: 'present' and 'absent'. Default: 'present'.
 511
 512 * `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.
 513
 514 * `include`: Configures include options. Valid options: a hash of available keys. Default: {}. Available keys are:
 515
 516   * `deb` - Specifies whether to request the distribution's compiled binaries. Valid options: `true` and `false`. Default: `true`.
 517
 518   * `src` - Specifies whether to request the distribution's uncompiled source code. Valid options: `true` and `false`. Default: `false`.
 519
 520 * `location`: *Required, unless `ensure` is set to 'absent'.* Specifies an Apt repository. Valid options: a string containing a repository URL. Default: undef.
 521
 522 * `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.
 523
 524 * `release`: Specifies a distribution of the Apt repository. Valid options: a string. Default: "$lsbdistcodename".
 525
 526   * `repos`: Specifies a component of the Apt repository. Valid options: a string. Default: 'main'.
 527
 528 * `notify_update`: *Optional.* Specifies whether to trigger an `apt-get update` run. Valid options: `true` and `false`. Default: `true`.
 529
 530 #### Type: `apt_key`
 531
 532 Manages the GPG keys that Apt uses to authenticate packages.
 533
 534 **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.
 535
 536 ##### Parameters
 537
 538 All parameters are optional.
 539
 540 * `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`.
 541
 542 * `options`: Passes additional options to `apt-key adv --keyserver-options`. Valid options: a string. Default: `undef`.
 543
 544 * `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`.
 545
 546 * `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`.
 547
 548 #### Defined Type: `apt::proxy`
 549
 550 Configures Apt to connect to a proxy server.
 551
 552 ##### Parameters
 553
 554 All parameters are optional.
 555
 556 * `host`: *Optional.* Specifies a proxy host to be stored in `/etc/apt/apt.conf.d/01proxy`. Valid options: a string containing a hostname. Default: `undef`.
 557
 558 * `port`: *Optional.* Specifies a proxy port to be stored in `/etc/apt/apt.conf.d/01proxy`. Valid options: an integer containing a port number. Default: `8080`.
 559
 560 * `https`: *Optional.* Specifies whether to enable https proxies. Valid options: `true` and `false`. Default: `false`.
 561
 562 * `direct`: *Optional.* 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`.
 563
 564 * `ensure`: *Optional.* Specifies whether the proxy should exist. Valid options: 'file', 'present', and 'absent'. Default: undef. Prefer 'file' over 'present'.
 565
 566 ## Limitations
 567
 568 This module is tested and officially supported on Debian 8 and 9 and Ubuntu 14.04, and 16.04. Testing on other platforms has been light and cannot be guaranteed.
 569
 570 This module is not designed to be split across [run stages](https://docs.puppetlabs.com/puppet/latest/reference/lang_run_stages.html).
 571
 572 ### Adding new sources or PPAs
 573
 574 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).
 575
 576 ```puppet
 577 Class['apt::update'] -> Package <| provider == 'apt' |>
 578 ```
 579
 580 ## Development
 581
 582 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.
 583
 584 For more information, see our [module contribution guide.](https://docs.puppetlabs.com/forge/contributing.html)
 585
 586 To see who's already involved, see the [list of contributors.](https://github.com/puppetlabs/puppetlabs-apt/graphs/contributors)