Fix typo
[puppet-modules/puppetlabs-apt.git] / README.md
index c7938a6a880879e875e204ab72f8fa8bb365b90e..3b62f8ae2892c08afa2782d061d7830a8bc7fd01 100644 (file)
--- a/README.md
+++ b/README.md
-apt
-===
+# apt
 
-[![Build Status](https://travis-ci.org/puppetlabs/puppetlabs-apt.png?branch=master)](https://travis-ci.org/puppetlabs/puppetlabs-apt)
+## Overview
 
-Overview
---------
+The apt module provides a simple interface for managing Apt source, key, and definitions with Puppet.
 
-The apt module provides a simple interface for managing APT source, key, and definitions with Puppet.
-
-Module Description
-------------------
+## Module Description
 
 The apt module automates obtaining and installing software packages on \*nix systems.
 
-***Note:** While this module allows the use of short keys, we **strongly** recommend that you **do not use short keys**, as they pose a serious security issue by opening you up to collision attacks.
-
-Setup
------
-
-**What apt affects:**
-
-* package/service/configuration files for APT
-    * NOTE: Setting the `purge_preferences` or `purge_preferences_d` parameters to 'true' will destroy any existing configuration that was not declared with Puppet. The default for these parameters is 'false'.
-* your system's `sources.list` file and `sources.list.d` directory
-    * NOTE: Setting the `purge_sources_list` and `purge_sources_list_d` parameters to 'true' will destroy any existing content that was not declared with Puppet. The default for these parameters is 'false'.
-* system repositories
-* authentication keys
-
-### Beginning with apt
-
-To begin using the apt module with default parameters, declare the class.
-
-    include apt
-
-Puppet code that uses anything from the apt module requires that the core apt class be declared.
-
-Usage
------
-
-Using the apt module consists predominantly of declaring classes that provide the desired functionality and features.
-
-### apt
-
-`apt` provides a number of common resources and options that are shared by the various defined types in this module, so you **must always** include this class in your manifests.
-
-The parameters for `apt` are not generally required and are predominantly for development environment use cases.
-
-    class { 'apt':
-      always_apt_update    => false,
-      disable_keys         => undef,
-      proxy_host           => false,
-      proxy_port           => '8080',
-      purge_sources_list   => false,
-      purge_sources_list_d => false,
-      purge_preferences_d  => false,
-      update_timeout       => undef,
-      fancy_progress       => undef
-    }
-
-Puppet will manage your system's `sources.list` file and `sources.list.d` directory but will do its best to respect existing content.
-
-If you declare your apt class with `purge_sources_list`, `purge_sources_list_d`, `purge_preferences` and `purge_preferences_d` set to 'true', Puppet will unapologetically purge any existing content it finds that wasn't declared with Puppet.
-
-### apt::builddep
-
-Installs the build depends of a specified package.
-
-    apt::builddep { 'glusterfs-server': }
-
-### apt::force
-
-Forces a package to be installed from a specific release. This class is particularly useful when using repositories, like Debian, that are unstable in Ubuntu.
-The cfg_files parameter controls wether newer or older configuration files should be used or only unchanged configuration files should be updated. Cfg_missing forces the provider to install all missing configuration files. Both are optional.
-
-    apt::force { 'glusterfs-server':
-      release     => 'unstable',
-      version     => '3.0.3',
-      cfg_files   => 'unchanged',
-      cfg_missing => true,
-      require     => Apt::Source['debian_unstable'],
-    }
-
-You can additionally set the following attributes:
+**Note**: While this module allows the use of short keys, **we urge you NOT to use short keys**, as they pose a serious security issue by opening you up to collision attacks.
 
- * `cfg_files`: "new", "old", "unchanged" or "none" (default). "new" will overwrite all existing configuration files with newer ones, "old" will force usage of all old files and "unchanged" only updates unchanged config files whereas setting "none" will don't do anything but providing backward-compatability with existing puppet manifests.
- * `cfg_missing`: "true" or "false". Setting cfg_missing to false will provide backward compatability whereas setting true will add an aptitude/apt-get parameter which checks and installs missing configuration files for the selected package.
+## Setup
 
-### apt_key
+### What apt affects:
 
-A native Puppet type and provider for managing GPG keys for APT is provided by this module.
+* Package/service/configuration files for Apt
+* Your system's `sources.list` file and `sources.list.d` directory
+* System repositories
+* Authentication keys
 
-    apt_key { 'puppetlabs':
-      ensure => 'present',
-      id     => '1054B7A24BD6EC30',
-    }
+**Note**: By default, this module will **destroy** any existing content in `sources.list` and `sources.list.d` that was not declared with Puppet.
 
-You can additionally set the following attributes:
-
- * `source`: HTTP, HTTPS or FTP location of a GPG key or path to a file on the
-             target host;
- * `content`: Instead of pointing to a file, pass the key in as a string;
- * `server`: The GPG key server to use. It defaults to *keyserver.ubuntu.com*;
- * `keyserver_options`: Additional options to pass to `--keyserver`.
-
-Because apt_key is a native type, it can be used in and queried for with MCollective.
-
-### apt::key
-
-Adds a key to the list of keys used by APT to authenticate packages. This type uses the aforementioned `apt_key` native type. As such, it no longer requires
-the `wget` command on which the old implementation depended.
+### Beginning with apt
 
-    apt::key { 'puppetlabs':
-      key        => '1054B7A24BD6EC30',
-      key_server => 'pgp.mit.edu',
-    }
+To begin using the apt module with default parameters, declare the class with `include apt`.
 
-    apt::key { 'jenkins':
-      key        => '9B7D32F2D50582E6',
-      key_source => 'http://pkg.jenkins-ci.org/debian/jenkins-ci.org.key',
-    }
+Any Puppet code that uses anything from the apt module requires that the core apt class be declared.
 
-### apt::pin
+## Usage
 
-Adds an apt pin for a certain release.
+Using the apt module consists predominantly of declaring classes and defined types that provide the desired functionality and features. This module provides common resources and options that are shared by the various defined types in the apt module, so you **must always** include this class in your manifests.
 
-    apt::pin { 'karmic': priority => 700 }
-    apt::pin { 'karmic-updates': priority => 700 }
-    apt::pin { 'karmic-security': priority => 700 }
+```
+class { 'apt': }
+```
 
-Note you can also specifying more complex pins using distribution properties.
+## Reference
 
-    apt::pin { 'stable':
-      priority        => -10,
-      originator      => 'Debian',
-      release_version => '3.0',
-      component       => 'main',
-      label           => 'Debian'
-    }
+### Classes
 
-If you wish to pin a number of packages you may specify the packages as a space
-delimited string using the `packages` attribute or pass in an array of package
-names.
+* `apt`: Main class, provides common resources and options. Allows Puppet to manage your system's sources.list file and sources.list.d directory. By default, it will purge any existing content it finds that wasn't declared with Puppet.
+  
+* `apt::params`: Sets defaults for the apt module parameters.
 
-### apt::hold
+* `apt::update`: Runs `apt-get update`, updating the list of available packages and their versions without installing or upgrading any packages. The update runs on the first Puppet run after you include the class, then whenever `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.
 
-When you wish to hold a package in Puppet, it should be done by passing in
-'held' as the ensure attribute to the package resource. However, a lot of
-public modules do not take this into account and generally do not work well
-with an ensure of 'held'.
+### Types
 
-Moreover, when Puppet is told to hold a package, it holds it at the current version installed; there is no way to tell it to both install a specific version **and** hold that version, unless you use an exec resource that wraps `dpkg --set-selections` or `apt-mark`.
+* `apt_key`
 
-At first glance, it seems this issue could also be solved by passing the version required to the ensure attribute---but that only means that Puppet will install that
-version after it processes the package. It does not inform apt that we want
-this package to be held; that is, should another package want to upgrade this one (because of a version requirement in a dependency, for example), we want apt to refuse. 
+  A native Puppet type and provider for managing GPG keys for Apt is provided by this module.
 
-To solve this issue, use apt::hold. Implement this by creating a preferences file with a priority of 1001. Under normal circumstances, this preference will always win. Because the priority is > 1000, apt will maintain the required version, downgrading the current package if necessary. 
+  ```
+  apt_key { 'puppetlabs':
+    ensure => 'present',
+    id     => '1054B7A24BD6EC30',
+  }
+  ```
 
-With this, you can now set a package's ensure attribute to 'latest' but get the version specified by apt::hold:
+  You can additionally set the following attributes:
 
-    apt::hold { 'vim':
-      version => '2:7.3.547-7',
-    }
+   * `source`: HTTP, HTTPS or FTP location of a GPG key or path to a file on the target host.
+   * `content`: Instead of pointing to a file, pass the key in as a string.
+   * `server`: The GPG key server to use. It defaults to *keyserver.ubuntu.com*.
+   * `options`: Additional options to pass to `apt-key`'s `--keyserver-options`.
 
-Alternatively, if you want to hold Vim at version 7.3.*, you can pass in a version with a glob:
+### Defined Types
 
-    apt::hold { 'vim':
-      version => '2:7.3.*',
-    }
+* `apt::conf`: Specifies a custom configuration file. The priority defaults to 50, but you can set the priority parameter to load the file earlier or later. The content parameter passes specified content, if any, into the file resource.
 
-### apt::ppa
+* `apt::key`: Adds a key to the list of keys used by Apt to authenticate packages. This type uses the aforementioned `apt_key` native type. As such, it no longer requires the `wget` command on which the old implementation depended.
 
-Adds a ppa repository using `add-apt-repository`.
+  ```
+  apt::key { 'puppetlabs':
+    id     => '1054B7A24BD6EC30',
+    server => 'pgp.mit.edu',
+  }
 
-    apt::ppa { 'ppa:drizzle-developers/ppa': }
+  apt::key { 'jenkins':
+    id     => '9B7D32F2D50582E6',
+    source => 'http://pkg.jenkins-ci.org/debian/jenkins-ci.org.key',
+  }
+  ```
 
-### apt::release
+* `apt::pin`: Defined type that adds an Apt pin for a certain release.
 
-Sets the default apt release. This class is particularly useful when using repositories, like Debian, that are unstable in Ubuntu.
+  ```
+  apt::pin { 'karmic': priority => 700 }
+  apt::pin { 'karmic-updates': priority => 700 }
+  apt::pin { 'karmic-security': priority => 700 }
+  ```
 
-    class { 'apt::release':
-      release_id => 'precise',
-    }
+  Note that you can also specify more complex pins using distribution properties.
 
-### apt::source
+  ```
+  apt::pin { 'stable':
+    priority        => -10,
+    originator      => 'Debian',
+    release_version => '3.0',
+    component       => 'main',
+    label           => 'Debian'
+  }
+  ```  
 
-Adds an apt source to `/etc/apt/sources.list.d/`.
+  If you want to pin a number of packages, you can specify the packages as a space-delimited string using the `packages` attribute, or you can pass in an array of package names.
 
-    apt::source { 'debian_unstable':
-      comment           => 'This is the iWeb Debian unstable mirror',
-      location          => 'http://debian.mirror.iweb.ca/debian/',
-      release           => 'unstable',
-      repos             => 'main contrib non-free',
-      required_packages => 'debian-keyring debian-archive-keyring',
-      key               => '8B48AD6246925553',
-      key_server        => 'subkeys.pgp.net',
-      pin               => '-10',
-      include_src       => true,
-      include_deb       => true
-    }
+* `apt::ppa`: Adds a PPA repository using `add-apt-repository`. For example, `apt::ppa { 'ppa:drizzle-developers/ppa': }`.
 
-If you would like to configure your system so the source is the Puppet Labs APT repository:
+* `apt::setting`: Defined type to abstract the creation of Apt configuration files.
 
-    apt::source { 'puppetlabs':
-      location   => 'http://apt.puppetlabs.com',
-      repos      => 'main',
-      key        => '1054B7A24BD6EC30',
-      key_server => 'pgp.mit.edu',
-    }
+* `apt::source`: Adds an Apt source to `/etc/apt/sources.list.d/`. For example:
 
-### apt::update
+  ```
+  apt::source { 'debian_unstable':
+    comment  => 'This is the iWeb Debian unstable mirror',
+    location => 'http://debian.mirror.iweb.ca/debian/',
+    release  => 'unstable',
+    repos    => 'main contrib non-free',
+    pin      => '-10',
+    key      => {
+      'id'     => '8B48AD6246925553',
+      'server' => 'subkeys.pgp.net',
+    },
+    include  => {
+      'src' => true,
+      'deb' => true,
+    },
+  }
+  ```  
 
-Runs `apt-get update`, updating the list of available packages and their versions without installing or upgrading any packages. 
+  For example, to configure your system so the source is the Puppet Labs Apt repository:
 
-The update runs on the first Puppet run after you include the class, then whenever `notify  => Exec['apt_update']` occurs---this should happen when config files get updated or other relevant changes occur. If you set the `always_apt_update` parameter, the update will run on every Puppet run.
+  ```
+  apt::source { 'puppetlabs':
+    location => 'http://apt.puppetlabs.com',
+    repos    => 'main',
+    key      => {
+      'id'     => '1054B7A24BD6EC30',
+      'server' => 'pgp.mit.edu',
+    },
+  ```
 
 ### Facts
 
-There are a few facts included in the apt module describing the state of the apt system:
+The apt module includes a few facts to describe the state of the Apt system:
+
+* `apt_updates`: The number of updates available on the system
+* `apt_security_updates`: The number of updates which are security updates
+* `apt_package_updates`: The package names that are available for update. In Facter 2.0 and later, this will be a list type; in earlier versions, it is a comma-delimited string.
+* `apt_update_last_success`: The date, in epochtime, of the most recent successful `apt-get update` run. This is determined by reading the mtime of  /var/lib/apt/periodic/update-success-stamp.
 
-* `apt_updates` --- the number of updates available on the system
-* `apt_security_updates` --- the number of updates which are security updates
-* `apt_package_updates` --- the package names that are available for update. In Facter 2.0 and later, this will be a list type; in earlier versions, it is a comma-delimited string.
+**Note:** The facts depend on 'update-notifier' being installed on your system. Though this is a GNOME daemon only the support files are needed so the package 'update-notifier-common' is enough to enable this functionality.
 
 #### Hiera example
+
+```
 <pre>
 apt::sources:
   'debian_unstable':
-      location: 'http://debian.mirror.iweb.ca/debian/'
-      release: 'unstable'
-      repos: 'main contrib non-free'
-      required_packages: 'debian-keyring debian-archive-keyring'
-      key: '9AA38DCD55BE302B'
-      key_server: 'subkeys.pgp.net'
-      pin: '-10'
-      include_src: 'true'
-      include_deb: 'true'
+    location: 'http://debian.mirror.iweb.ca/debian/'
+    release: 'unstable'
+    repos: 'main contrib non-free'
+    key:
+      id: '9AA38DCD55BE302B'
+      server: 'subkeys.pgp.net'
+    pin: '-10'
+    include:
+      src: true
+      deb: true
 
   'puppetlabs':
-      location: 'http://apt.puppetlabs.com'
-      repos: 'main'
-      key: '1054B7A24BD6EC30'
-      key_server: 'pgp.mit.edu'
+    location: 'http://apt.puppetlabs.com'
+    repos: 'main'
+    key:
+      id:'1054B7A24BD6EC30'
+      server: 'pgp.mit.edu'
 </pre>
-
-### Testing
-
-The apt module is mostly a collection of defined resource types, which provide reusable logic that can be leveraged to manage APT. It provides smoke tests for testing functionality on a target system, as well as spec tests for checking a compiled catalog against an expected set of resources.
-
-#### Example Test
-
-This test will set up a Puppet Labs APT repository. Start by creating a new smoke test, called puppetlabs-apt.pp, in the apt module's test folder. In this test, declare a single resource representing the Puppet Labs APT source and GPG key:
-
-    apt::source { 'puppetlabs':
-      location   => 'http://apt.puppetlabs.com',
-      repos      => 'main',
-      key        => '1054B7A24BD6EC30',
-      key_server => 'pgp.mit.edu',
-    }
-
-This resource creates an APT source named puppetlabs and gives Puppet information about the repository's location and the key used to sign its packages. Puppet leverages Facter to determine the appropriate release, but you can set this directly by adding the release type.
-
-Check your smoke test for syntax errors:
-
-    $ puppet parser validate tests/puppetlabs-apt.pp
-
-If you receive no output from that command, it means nothing is wrong. Then, apply the code:
-
-    $ puppet apply --verbose tests/puppetlabs-apt.pp
-    notice: /Stage[main]//Apt::Source[puppetlabs]/File[puppetlabs.list]/ensure: defined content as '{md5}3be1da4923fb910f1102a233b77e982e'
-    info: /Stage[main]//Apt::Source[puppetlabs]/File[puppetlabs.list]: Scheduling refresh of Exec[puppetlabs apt update]
-    notice: /Stage[main]//Apt::Source[puppetlabs]/Exec[puppetlabs apt update]: Triggered 'refresh' from 1 events>
-
-The above example uses a smoke test to lay out a resource declaration and apply it on your system. In production, you might want to declare your APT sources inside the classes where they’re needed.
-
-Implementation
---------------
-
-### apt::backports
-
-Adds the necessary components to get backports for Ubuntu and Debian. The release name defaults to `$lsbdistcodename`. Setting this manually can cause undefined behavior (read: universe exploding).
-
-By default this class drops a Pin-file for Backports, pinning it to a priority of 200. This is lower than the normal Debian archive, which gets a priority of 500 to ensure that packages with `ensure => latest` don't get magically upgraded from Backports without your explicit permission.
-
-If you raise the priority through the `pin_priority` parameter to *500*, identical to the rest of the Debian mirrors, normal policy goes into effect and the newest version wins/becomes the candidate apt will want to install or upgrade to. This means that if a package is available from Backports it and its dependencies will be pulled in from Backports unless you explicitly set the `ensure` attribute of the `package` resource to `installed`/`present` or a specific version.
+```
+
+### Parameters
+
+#### apt
+
+* `update`: Hash to configure various update settings. Valid keys are:
+  * 'frequency': The run frequency for `apt-get update`. Defaults to 'reluctantly'. Accepts the following values:
+    * 'always': Runs update at every Puppet run.
+    * 'daily': Runs update daily; that is, `apt-get update` runs if the value of `apt_update_last_success` is less than current epoch time - 86400. If the exec resource `apt_update` is notified, `apt-get update` runs regardless of this value. 
+    * 'weekly': Runs update weekly; that is, `apt-get update` runs if the value of `apt_update_last_success` is less than current epoch time - 604800. If the exec resource `apt_update` is notified, `apt-get update` runs regardless of this value. 
+    * 'reluctantly': Only runs `apt-get update` if the exec resource `apt_update` is notified. This is the default setting.  
+  * 'timeout': Overrides the exec timeout in seconds for `apt-get update`. Defaults to exec default (300).
+  * 'tries': Sets how many times to attempt running `apt-get update`. Use this to work around transient DNS and HTTP errors. By default, the command runs only once.
+* `purge`: Hash to configure various purge settings. Valid keys are:
+  * 'sources.list': If set to 'true', Puppet purges all unmanaged entries from sources.list. Accepts `true` or `false`. Defaults to `true`.
+  * 'sources.list.d': If set to 'true', Puppet purges all unmanaged entries from sources.list.d. Accepts `true` or `false`. Defaults to `true`.
+  * 'preferences.list': If set to 'true', Puppet purges all unmanaged entries from preferences.list. Accepts `true` or `false`. Defaults to `true`.
+  * 'preferences.list.d': If set to 'true', Puppet purges all unmanaged entries from preferences.list.d. Accepts `true` or `false`. Defaults to `true`.
+* `proxy`: Hash to configure various proxy settings. Valid keys are:
+  * 'host': Configures a proxy host and stores the configuration in /etc/apt/apt.conf.d/01proxy.
+  * 'port': Configures a proxy port and stores the configuration in /etc/apt/apt.conf.d/01proxy.
+  * 'https': Boolean to configure whether or not to enable https proxies. Defaults to false.
+* `keys`: Passes a hash to create_resource to make new `apt::key` resources.
+* `ppas`: Passes a hash to create_resource to make new `apt::ppa` resources.
+* `settings`: Passes a hash to create_resource to make new `apt::setting` resources.
+* `sources`: Passes a hash to create_resource to make new `apt::source` resources.
+
+####apt::conf
+
+* `content`: The content of the configuration file.
+* `ensure`: Whether the configuration file should be 'present' or 'absent'. Defaults to 'present'.
+* `priority`: Numeric priority for the configuration file. Defaults to '50'.
+
+####apt::key
+
+* `ensure`: The state we want this key in. Can be 'present' or 'absent'.
+* `id`: Is a GPG key ID or full key fingerprint. This value is validated with a regex enforcing it to only contain valid hexadecimal characters, be precisely 8 or 16 hexadecimal characters long and optionally prefixed with 0x for key IDs, or 40 hexadecimal characters long for key fingerprints.
+* `content`: This parameter can be used to pass in a GPG key as a string in case it cannot be fetched from a remote location and using a file resource is for other reasons inconvenient.
+* `source`: This parameter can be used to pass in the location of a GPG key. This URI can take the form of a `URL` (ftp, http or https) and a `path` (absolute path to a file on the target system).
+* `server`: The keyserver from where to fetch our GPG key. It can either be a domain name or URL. It defaults to 'keyserver.ubuntu.com'.
+* `options`: Additional options to pass on to `apt-key adv --keyserver-options`.
+
+####apt::pin
+
+* `ensure`: The state we want this pin in. Can be 'present' or 'absent'.
+* `explanation`: Add a comment. Defaults to `${caller_module_name}: ${name}`.
+* `order`: The order of the file name. Defaults to undef, otherwise must be an integer.
+* `packages`: The list of packages to pin. Defaults to '\*'. Can be an array or string. 
+* `priority`: Several versions of a package may be available for installation when the sources.list(5) file contains references to more than one distribution (for example, stable and testing). APT assigns a priority to each version that is available. Subject to dependency constraints, apt-get selects the version with the highest priority for installation.
+* `release`: The Debian release. Defaults to ''. Typical values can be 'stable', 'testing' and 'unstable'.
+* `origin`: Can be used to match a hostname. The following record will assign a high priority to all versions available from the server identified by the hostname. Defaults to ''.
+* `version`: The specific form assigns a priority (a "Pin-Priority") to one or more specified packages with a specified version or version range.
+* `codename`: The distribution (lsbdistcodename) of the apt repository. Defaults to ''.
+* `release_version`: Names the release version. For example, the packages in the tree might belong to Debian release version 7. Defaults to ''.
+* `component`: Names the licensing component associated with the packages in the directory tree of the Release file. defaults to ''. Typical values can be 'main', 'dependencies' and 'restricted'
+* `originator`: Names the originator of the packages in the directory tree of the Release file. Defaults to ''. Most commonly, this is Debian.
+* `label`: Names the label of the packages in the directory tree of the Release file. Defaults to ''. Most commonly, this is Debian.
+
+**Note**: Parameters release, origin, and version are mutually exclusive.
+
+It is recommended to read the manpage 'apt_preferences(5)'
+
+####apt::ppa
+
+* `ensure`: Whether to add or remove the PPA. Valid values are 'present' or 'absent'. Defaults to 'present'.
+* `options`: Options to pass to `add-apt-repository`. OS-dependent defaults are defined in `apt::params`.
+* `release`: OS-release, used in the filename of the generated sources.list.d file. Defaults to `$::lsbdistcodename`.
+* `package_name`: The package to install `add-apt-repository`. OS-dependent defaults are defined in `apt::params`.
+* `package_manage`: Whether or not to manage the package for `add-apt-repository`. Defaults to false.
+
+####apt::setting
+
+* `priority`: Integer or zero-padded integer setting the file priority. Defaults to 50.
+* `ensure`: Whether to add or remove the file. Valid values are 'present', 'absent', and 'file'. Defaults to `file`.
+* `source`: The source for the file. Exactly one of `content` and `source` must be specified.
+* `content`: The content for the file. Exactly one of `content` and `source` must be specified.
+* `notify_update`: Boolean for whether or not this `apt::setting` should trigger an `apt-get update`. Defaults to `true`.
+
+####apt::source
+
+* `comment`: Add a comment to the apt source file.
+* `ensure`: Allows you to remove the apt source file. Can be 'present' or 'absent'.
+* `location`: The URL of the apt repository. Defaults to undef. Required unless `ensure => 'absent'`.
+* `release`: The distribution of the apt repository. Defaults to fact 'lsbdistcodename'.
+* `repos`: The component of the apt repository. This defaults to 'main'.
+* `include`: Hash to configure include options. Valid keys are:
+  * 'deb': References a Debian distribution's binary package. Defaults to `true`.
+  * 'src': Enable the deb-src type, references a Debian distribution's source code in the same form as the `include['deb']` type. A deb-src line is required to fetch source indexes. Defaults to `false`.
+* `key`: Add key from source. Takes either a string or a hash. If a string, the value will be passed to `id` in the `apt::key`. If a hash, valid keys are:
+  * 'id': See `id` in `apt::key`. Required if a hash is specified.
+  * 'server': See `server` in `apt::key`
+  * 'content': See `content` in `apt::key`
+  * 'source': See `source` in `apt::key`
+  * 'options': See `options` in `apt::key`
+* `pin`: See apt::pin. Defaults to false.
+* `architecture`: can be used to specify for which architectures information should be downloaded. If this option is not set all architectures defined by the APT::Architectures option will be downloaded. Defaults to `undef` which means all. Example values can be 'i386' or 'i386,alpha,powerpc'.
+* `allow_unsigned`: can be set to indicate that packages from this source are always authenticated even if the Release file is not signed or the signature can't be checked. Defaults to `false`. Can be `true` or `false`.
 
 Limitations
 -----------
 
-This module should work across all versions of Debian/Ubuntu and support all major APT repository management features.
+This module should work across all versions of Debian/Ubuntu and support all major Apt repository management features.
 
 Development
 ------------
@@ -332,3 +322,4 @@ A lot of great people have contributed to this module. A somewhat current list f
 * Zach Leslie <zach@puppetlabs.com>
 * Daniele Sluijters <github@daenney.net>
 * Daniel Paulus <daniel@inuits.eu>
+* Wolf Noble <wolf@wolfspyre.com>