# apt
-[](https://travis-ci.org/puppetlabs/puppetlabs-apt)
-
## Overview
The apt module provides a simple interface for managing Apt source, key, and definitions with Puppet.
* System repositories
* Authentication keys
-**Note**: Setting the apt module's `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'.
+**Note**: By default, this module will **destroy** any existing content in `sources.list` and `sources.list.d` that was not declared with Puppet.
### Beginning with apt
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.
```
-class { 'apt':
- always_apt_update => false,
- apt_update_frequency => undef,
- 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
-}
+class { 'apt': }
```
## Reference
### Classes
-* `apt`: Main class, provides common resources and options. Allows Puppet to manage your system's sources.list file and sources.list.d directory, but it does 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`: 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::backports`: This class adds the necessary components to get backports for Ubuntu and Debian. The release name defaults to `$lsbdistcodename`. Setting this manually can cause undefined and potentially serious behavior.
-
- 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 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.
-
* `apt::params`: Sets defaults for the apt module parameters.
-* `apt::release`: Sets the default Apt release. This class is particularly useful when using repositories that are unstable in Ubuntu, such as Debian.
-
- ```
- class { 'apt::release':
- release_id => 'precise',
- }
- ```
-
-* `apt::unattended_upgrades`: This class manages the unattended-upgrades package and related configuration files for Ubuntu and Debian systems. You can configure the class to automatically upgrade all new package releases or just security releases.
-
- ```
- class { 'apt::unattended_upgrades':
- origins => $::apt::params::origins,
- blacklist => [],
- update => '1',
- download => '1',
- upgrade => '1',
- autoclean => '7',
- }
- ```
-
-* `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 the `always_apt_update` parameter to 'true', the update runs on every Puppet run.
+* `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 `true`, the update runs on every Puppet run.
### Types
* `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, you can use it and query for it with MCollective.
+ * `options`: Additional options to pass to `apt-key`'s `--keyserver-options`.
### Defined Types
-* `apt::builddep`: Installs the build dependencies of a specified package.
-
- `apt::builddep { 'glusterfs-server': }`
-
* `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::hold`: Holds a specific version of a package. You can hold a package to a full version or a partial version.
-
- To 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',
- }
- ```
-
- Alternatively, if you want to hold your package at a partial version, you can use a wildcard. For example, you can hold Vim at version 7.3.*:
-
-
- ```
- apt::hold { 'vim':
- version => '2:7.3.*',
- }
- ```
-
-* `apt::force`: Forces a package to be installed from a specific release. This is particularly useful when using repositories that are unstable in Ubuntu, such as Debian.
-
- ```
- apt::force { 'glusterfs-server':
- release => 'unstable',
- version => '3.0.3',
- cfg_files => 'unchanged',
- cfg_missing => true,
- require => Apt::Source['debian_unstable'],
- }
- ```
-
- Valid values for `cfg_files` are:
- * 'new': Overwrites all existing configuration files with newer ones.
- * 'old': Forces usage of all old files.
- * 'unchanged: Updates only unchanged config files.
- * 'none': Provides backward-compatibility with existing Puppet manifests.
-
- Valid values for `cfg_missing` are 'true', 'false'. Setting this to 'false' provides backward compatibility; setting it to 'true' checks for and installs missing configuration files for the selected package.
-
* `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.
```
apt::key { 'puppetlabs':
- key => '1054B7A24BD6EC30',
- key_server => 'pgp.mit.edu',
+ id => '1054B7A24BD6EC30',
+ server => 'pgp.mit.edu',
}
apt::key { 'jenkins':
- key => '9B7D32F2D50582E6',
- key_source => 'http://pkg.jenkins-ci.org/debian/jenkins-ci.org.key',
+ id => '9B7D32F2D50582E6',
+ source => 'http://pkg.jenkins-ci.org/debian/jenkins-ci.org.key',
}
```
* `apt::ppa`: Adds a PPA repository using `add-apt-repository`. For example, `apt::ppa { 'ppa:drizzle-developers/ppa': }`.
+* `apt::setting`: Defined type to abstract the creation of Apt configuration files.
+
* `apt::source`: Adds an Apt source to `/etc/apt/sources.list.d/`. For example:
```
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
+ 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,
+ },
}
```
```
apt::source { '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',
+ },
```
### Facts
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'
+ key:
+ id: '9AA38DCD55BE302B'
+ server: 'subkeys.pgp.net'
pin: '-10'
- include_src: 'true'
- include_deb: 'true'
+ include:
+ src: true
+ deb: true
'puppetlabs':
location: 'http://apt.puppetlabs.com'
repos: 'main'
- key: '1054B7A24BD6EC30'
- key_server: 'pgp.mit.edu'
+ key:
+ id:'1054B7A24BD6EC30'
+ server: 'pgp.mit.edu'
</pre>
```
#### apt
-* `always_apt_update`: Set to 'true' to update Apt on every run. This setting is intended for development environments where package updates are frequent. Defaults to 'false'.
-* `apt_update_frequency`: Sets 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.
-* `disable_keys`: Disables the requirement for all packages to be signed.
-* `proxy_host`: Configures a proxy host and stores the configuration in /etc/apt/apt.conf.d/01proxy.
-* `proxy_port`: Configures a proxy port and stores the configuration in /etc/apt/apt.conf.d/01proxy.
-* `purge_sources_list`: If set to 'true', Puppet purges all unmanaged entries from sources.list. Accepts 'true' or 'false'. Defaults to 'false'.
-* `purge_sources_list_d`: If set to 'true', Puppet purges all unmanaged entries from sources.list.d. Accepts 'true' or 'false'. Defaults to 'false'.
-* `update_timeout`: Overrides the exec timeout in seconds for `apt-get update`. Defaults to exec default (300).
-* `update_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.
+* `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.
-* `fancy_progress`: Enables fancy progress bars for apt. Accepts 'true', 'false'. Defaults to 'false'.
-####apt::unattended_upgrades
+####apt::conf
-* `origins`: The repositories from which to automatically upgrade included packages.
-* `blacklist`: A list of packages to **not** automatically upgrade.
-* `update`: How often, in days, to run `apt-get update`.
-* `download`: How often, in days, to run `apt-get upgrade --download-only`.
-* `upgrade`: How often, in days, to upgrade packages included in the origins list.
-* `autoclean`: How often, in days, to run `apt-get autoclean`.
-* `randomsleep`: How long, in seconds, to randomly wait before applying upgrades.
-
-####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.
-* `release`: The distribution of the apt repository. Defaults to fact 'lsbdistcodename'.
-* `repos`: The component of the apt repository. This defaults to 'main'.
-* `include_deb`: References a Debian distribution's binary package.
-* `include_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.
-* `required_packages`: install required packages via an exec. defaults to 'false'.
-* `key`: See apt::key
-* `key_server`: See apt::key
-* `key_content`: See apt::key
-* `key_source`: See apt::key
-* `pin`: See apt::pin
-* `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'.
-* `trusted_source` 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'.
+* `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'.
-* `key`: 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.
-* `key_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.
-* `key_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).
-* `key_server`: The keyserver from where to fetch our GPG key. It can either be a domain name or URL. It defaults to undef which results in apt_key's default keyserver being used, currently `keyserver.ubuntu.com`.
-* `key_options`: Additional options to pass on to `apt-key adv --keyserver-options`.
+* `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 '', otherwise must be an integer.
+* `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'.
It is recommended to read the manpage 'apt_preferences(5)'
-### Testing
-
-The apt module is mostly a collection of defined resource types, which provide reusable logic for managing 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 sets 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.
+####apt::ppa
-Check your smoke test for syntax errors:
+* `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.
-`$ puppet parser validate tests/puppetlabs-apt.pp`
+####apt::setting
-If you receive no output from that command, it means nothing is wrong. Then, apply the code:
+* `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`.
-```
-$ 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>
-```
+####apt::source
-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.
+* `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
-----------
Code Review / puppet-modules / puppetlabs-apt.git / commitdiff