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
------------------
-APT automates obtaining and installing software packages on \*nix systems.
+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 in that they open you up to collision attacks.*
+***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:**
+**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'.
+ * 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
+### Beginning with apt
-To begin using the APT module with default parameters, declare the class
+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.
+Puppet code that uses anything from the apt module requires that the core apt class be declared.
Usage
-----
-Using the APT module consists predominantly in declaring classes that provide desired functionality and features.
+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.
+`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 required in general and are predominantly for development environment use-cases.
+The parameters for `apt` are not generally required and are predominantly for development environment use cases.
class { 'apt':
always_apt_update => false,
### 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.
+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.
apt::force { 'glusterfs-server':
release => 'unstable',
### apt_key
-A native Puppet type and provider for managing GPG keys for APT is provided by
-this module.
+A native Puppet type and provider for managing GPG keys for APT is provided by this module.
apt_key { 'puppetlabs':
ensure => 'present',
* `server`: The GPG key server to use. It defaults to *keyserver.ubuntu.com*;
* `keyserver_options`: Additional options to pass to `--keyserver`.
-Because it is a native type it can be used in and queried for with MCollective.
+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 that the old implementation depended on.
+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.
apt::key { 'puppetlabs':
key => '1054B7A24BD6EC30',
### apt::hold
-When you wish to hold a package in Puppet is should be done by passing in
+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'.
-There is an additional issue that when Puppet is told to hold a package, it
-will hold it at the current version installed, there is no way to tell it in
-one go to install a specific version and then hold that version without using
-an exec resource that wraps `dpkg --set-selections` or `apt-mark`.
+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`.
-At first glance this could also be solved by just passing the version required
-to the ensure attribute but that only means that Puppet will install that
-version once it processes that package. It does not inform apt that we want
-this package to be held. In other words; if another package somehow wants to
-upgrade this one (because of a version requirement in a dependency), apt
-should not allow it.
+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.
-In order to solve this you can use apt::hold. It's implemented by creating
-a preferences file with a priority of 1001, meaning that under normal
-circumstances this preference will always win. Because the priority is > 1000
-apt will interpret this as 'this should be the version installed and I am
-allowed to downgrade the current package if needed'.
+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.
-With this you can now set a package's ensure attribute to 'latest' but still
-get the version specified by apt::hold. You can do it like this:
+With this, you can now set a package's ensure attribute to 'latest' but get the version specified by apt::hold:
apt::hold { 'vim':
version => '2:7.3.547-7',
}
-Since you might just want to hold Vim at version 7.3 and not care about the
-rest you can also pass in a version with a glob:
+Alternatively, if you want to hold Vim at version 7.3.*, you can pass in a version with a glob:
apt::hold { 'vim':
version => '2:7.3.*',
include_deb => true
}
-If you would like to configure your system so the source is the Puppet Labs APT repository
+If you would like to configure your system so the source is the Puppet Labs APT repository:
apt::source { 'puppetlabs':
location => 'http://apt.puppetlabs.com',
key_server => 'pgp.mit.edu',
}
+### 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---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.
+
### Facts
-There are a few facts included within the apt module describing the state of the apt system:
+There are a few facts included in the apt module describing 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. On Facter 2.0 and newer this will be a list type, in earlier versions it is a comma delimitered string.
+* `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.
#### Hiera example
<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 does provide 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.
+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 in the apt module's test folder. Call it puppetlabs-apt.pp. Inside, declare a single resource representing the Puppet Labs APT source and gpg key
+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',
key_server => 'pgp.mit.edu',
}
-This resource creates an apt source named puppetlabs and gives Puppet information about the repository's location and key used to sign its packages. Puppet leverages Facter to determine the appropriate release, but you can set it directly by adding the release type.
+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
+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
+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 used a smoke test to easily lay out a resource declaration and apply it on your system. In production, you may want to declare your APT sources inside the classes where they’re needed.
+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
--------------
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, lower than the normal Debian archive which gets a priority of 500 to ensure your packages with `ensure => latest` don't get magically upgraded from Backports without your explicit say-so.
+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.
Code Review / puppet-modules / puppetlabs-apt.git / commitdiff