# apt
-## Overview
-
-The apt module provides a simple interface for managing Apt source, key, and definitions with Puppet.
+#### Table of Contents
+
+1. [Module Description - What the module does and why it is useful](#module-description)
+1. [Setup - The basics of getting started with apt](#setup)
+ * [What apt affects](#what-apt-affects)
+ * [Beginning with apt](#beginning-with-apt)
+1. [Usage - Configuration options and additional functionality](#usage)
+ * [Add GPG keys](#add-gpg-keys)
+ * [Prioritize backports](#prioritize-backports)
+ * [Update the list of packages](#update-the-list-of-packages)
+ * [Pin a specific release](#pin-a-specific-release)
+ * [Add a Personal Package Archive repository](#add-a-personal-package-archive-repository)
+ * [Configure Apt from Hiera](#configure-apt-from-hiera)
+ * [Replace the default sources.list file](#replace-the-default-sourceslist-file)
+1. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
+1. [Limitations - OS compatibility, etc.](#limitations)
+1. [Development - Guide for contributing to the module](#development)
+
+<a id="module-description"></a>
## Module Description
-The apt module automates obtaining and installing software packages on \*nix systems.
+The apt module lets you use Puppet to manage APT (Advanced Package Tool) sources, keys, and other configuration options.
+
+APT 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.
+
+**Note**: Prior to Puppet 7, 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. With Puppet 7 the `lsb-release` package is not needed.
-**Note**: While this module allows the use of short keys, **warnings are thrown if a full fingerprint is not used**, as they pose a serious security issue by opening you up to collision attacks.
+<a id="setup"></a>
## Setup
-### What apt affects:
+<a id="what-apt-affects"></a>
-* Package/service/configuration files for Apt
+### What apt affects
+
+* Your system's `preferences` file and `preferences.d` directory
* Your system's `sources.list` file and `sources.list.d` directory
+* Your system's `apt.conf.d` directory
* 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'.
-
-### Beginning with apt
-
-To begin using the apt module with default parameters, declare the class with `include apt`.
+**Note:** This module offers `purge` parameters which, if set to `true`, **destroy** any configuration on the node's `sources.list(.d)`, `preferences(.d)` and `apt.conf.d` that you haven't declared through Puppet. The default for these parameters is `false`.
-Any Puppet code that uses anything from the apt module requires that the core apt class be declared.
+<a id="beginning-with-apt"></a>
-## Usage
+### 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.
+To use the apt module with default parameters, declare the `apt` class.
-```
-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
-}
+```puppet
+include apt
```
-## Reference
+**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.
-### Classes
+<a id="usage"></a>
-* `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.
+## Usage
- 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::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.
+<a id="add-gpg-keys"></a>
- 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.
+### Add GPG keys
- 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.
+**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.
-* `apt::params`: Sets defaults for the apt module parameters.
+Declare the `apt::key` defined type:
-* `apt::release`: Sets the default Apt release. This class is particularly useful when using repositories that are unstable in Ubuntu, such as Debian.
+```puppet
+apt::key { 'puppetlabs':
+ id => '6F6B15509CF8E59E6E469F327F438280EF8D349F',
+ server => 'pgp.mit.edu',
+ options => 'http-proxy="http://proxyuser:proxypass@example.org:3128"',
+}
+```
- ```
- class { 'apt::release':
- release_id => 'precise',
- }
- ```
+<a id="prioritize-backports"></a>
-* `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.
+### Prioritize backports
- ```
- class { 'apt::unattended_upgrades':
- 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.
+```puppet
+class { 'apt::backports':
+ pin => 500,
+}
+```
-### Types
+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.
-* `apt_key`
+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.
- A native Puppet type and provider for managing GPG keys for Apt is provided by this module.
+<a id="update-the-list-of-packages"></a>
- ```
- apt_key { 'puppetlabs':
- ensure => 'present',
- id => '47B320EB4C7C375AA9DAE1A01054B7A24BD6EC30',
- }
- ```
+### Update the list of packages
- You can additionally set the following attributes:
+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':
- * `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`.
+```puppet
+class { 'apt':
+ update => {
+ frequency => 'daily',
+ },
+}
+```
- Because apt_key is a native type, you can use it and query for it with MCollective.
+When `Exec['apt_update']` is triggered, it generates a `notice`-level message. Because the default [logging level for agents](https://puppet.com/docs/puppet/latest/configuration.html#loglevel) is `notice`, this causes the repository update to appear in agent logs. To silence these updates from the default log output, set the [loglevel](https://puppet.com/docs/puppet/latest/metaparameter.html#loglevel) metaparameter for `Exec['apt_update']` above the agent logging level:
-### Defined Types
+```puppet
+class { 'apt':
+ update => {
+ frequency => 'daily',
+ loglevel => 'debug',
+ },
+}
+```
-* `apt::builddep`: Installs the build dependencies of a specified package.
+> **NOTE:** Every `Exec['apt_update']` run will generate a corrective change, even if the apt caches are not updated. For example, setting an update frequency of `always` can result in every Puppet run resulting in a corrective change. This is a known issue. For details, see [MODULES-10763](https://tickets.puppetlabs.com/browse/MODULES-10763).
- `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.
+<a id="pin-a-specific-release"></a>
-* `apt::hold`: Holds a specific version of a package. You can hold a package to a full version or a partial version.
+### Pin a specific release
- To set a package's ensure attribute to 'latest' but get the version specified by `apt::hold`:
+```puppet
+apt::pin { 'karmic': priority => 700 }
+apt::pin { 'karmic-updates': priority => 700 }
+apt::pin { 'karmic-security': priority => 700 }
+```
- ```
- apt::hold { 'vim':
- version => '2:7.3.547-7',
- }
- ```
+You can also specify more complex pins using distribution properties:
- 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.*:
+```puppet
+apt::pin { 'stable':
+ priority => -10,
+ originator => 'Debian',
+ release_version => '3.0',
+ component => 'main',
+ label => 'Debian'
+}
+```
+To pin multiple packages, pass them to the `packages` parameter as an array or a space-delimited string.
- ```
- apt::hold { 'vim':
- version => '2:7.3.*',
- }
- ```
+<a id="add-a-personal-package-archive-repository"></a>
-* `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.
+### Add a Personal Package Archive (PPA) repository
- ```
- apt::force { 'glusterfs-server':
- release => 'unstable',
- version => '3.0.3',
- cfg_files => 'unchanged',
- cfg_missing => true,
- require => Apt::Source['debian_unstable'],
- }
- ```
+```puppet
+apt::ppa { 'ppa:drizzle-developers/ppa': }
+```
- 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 => '47B320EB4C7C375AA9DAE1A01054B7A24BD6EC30',
- key_server => 'pgp.mit.edu',
- }
-
- apt::key { 'jenkins':
- key => '150FDE3F7787E7D11EF4E12A9B7D32F2D50582E6',
- key_source => 'http://pkg.jenkins-ci.org/debian/jenkins-ci.org.key',
- }
- ```
-
-* `apt::pin`: Defined type that adds an Apt pin for a certain release.
-
- ```
- apt::pin { 'karmic': priority => 700 }
- apt::pin { 'karmic-updates': priority => 700 }
- apt::pin { 'karmic-security': priority => 700 }
- ```
-
- Note that you can also specify more complex pins using distribution properties.
-
- ```
- apt::pin { 'stable':
- priority => -10,
- originator => 'Debian',
- release_version => '3.0',
- component => 'main',
- label => 'Debian'
- }
- ```
-
- 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::ppa`: Adds a PPA repository using `add-apt-repository`. For example, `apt::ppa { 'ppa:drizzle-developers/ppa': }`.
-
-* `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 => 'A1BD8E9D78F7FE5C3E65D8AF8B48AD6246925553',
- key_server => 'subkeys.pgp.net',
- pin => '-10',
- include_src => true,
- include_deb => true
- }
- ```
-
- For example, to configure your system so the source is the Puppet Labs Apt repository:
-
- ```
- apt::source { 'puppetlabs':
- location => 'http://apt.puppetlabs.com',
- repos => 'main dependencies',
- key => '47B320EB4C7C375AA9DAE1A01054B7A24BD6EC30',
- key_server => 'pgp.mit.edu',
- }
- ```
+### Add an Apt source to `/etc/apt/sources.list.d/`
+
+```puppet
+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' => 'A1BD8E9D78F7FE5C3E65D8AF8B48AD6246925553',
+ 'server' => 'subkeys.pgp.net',
+ },
+ include => {
+ 'src' => true,
+ 'deb' => true,
+ },
+}
+```
-### Facts
+To use the Puppet Apt repository as a source:
-The apt module includes a few facts to describe the state of the Apt system:
+```puppet
+apt::source { 'puppetlabs':
+ location => 'http://apt.puppetlabs.com',
+ repos => 'main',
+ key => {
+ 'id' => '6F6B15509CF8E59E6E469F327F438280EF8D349F',
+ 'server' => 'pgp.mit.edu',
+ },
+}
+```
-* `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.
+<a id="configure-apt-from-hiera"></a>
-**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.
+### Configure Apt from Hiera
-#### Hiera example
+Instead of specifying your sources directly as resources, you can instead just include the `apt` class, which will pick up the values automatically from hiera.
-```
-<pre>
+```yaml
apt::sources:
'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: '9AA38DCD55BE302B'
- key_server: 'subkeys.pgp.net'
pin: '-10'
- include_src: true
- include_deb: true
+ key:
+ id: 'A1BD8E9D78F7FE5C3E65D8AF8B48AD6246925553'
+ server: 'subkeys.pgp.net'
+ include:
+ src: true
+ deb: true
'puppetlabs':
location: 'http://apt.puppetlabs.com'
- repos: 'main dependencies'
- key: '47B320EB4C7C375AA9DAE1A01054B7A24BD6EC30'
- key_server: 'pgp.mit.edu'
-</pre>
+ repos: 'main'
+ key:
+ id: '6F6B15509CF8E59E6E469F327F438280EF8D349F'
+ server: 'pgp.mit.edu'
```
-### Parameters
-
-#### 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.
-* `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
-
-* `legacy_origin`: If set to true, use the old `Unattended-Upgrade::Allowed-Origins` variable. If false, use `Unattended-Upgrade::Origins-Pattern`. OS-dependent defaults are defined in `apt::params`.
-* `origins`: The repositories from which to automatically upgrade included packages. OS-dependent defaults are defined in `apt::params`. (Usually only security updates are enabled by default)
-* `blacklist`: A list of packages to **not** automatically upgrade. This list is empty by default.
-* `update`: How often, in days, to run `apt-get update`. Defaults to '1'.
-* `download`: How often, in days, to run `apt-get upgrade --download-only`. Defaults to '1'.
-* `upgrade`: How often, in days, to upgrade packages included in the origins list. Defaults to '1'.
-* `autoclean`: How often, in days, to run `apt-get autoclean`. Defaults to '7'.
-* `auto_fix`: Tries to automatically fix interrupted package installations. Defaults to 'true'.
-* `minimal_steps`: Split the upgrade process into sections to allow shutdown during upgrade. Defaults to 'false'.
-* `install_on_shutdown`: Install updates on shutdown instead of in the background. Defaults to 'false'.
-* `mail_to`: Send e-mail to this address about packages upgrades or errors. This is not set by default.
-* `mail_only_on_error`: Send e-mail only in case of error, not on successful upgrade. Defaults to 'false'.
-* `remove_unused`: Removes unused dependencies. Defaults to 'true'.
-* `auto_reboot`: Reboot the system **without confirmation** if an update requires rebooting. Defaults to 'false'.
-* `dl_limit`: Use a bandwidth limit for downloading, specified in kb/sec. This is not set by default.
-* `randomsleep`: How long, in seconds, to randomly wait before applying upgrades. This is not set by default.
-
-####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'.
-
-####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`.
-
-####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.
-* `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 we are adding or removing the PPA. Can be 'present' or 'absent'. Defaults to 'present'.
-* `release`: The codename for the operating system you're running. Defaults to `$lsbdistcodename`. Required if lsb-release is not installed.
-* `options`: Options to be passed to the `apt-add-repository` command. OS-dependent defaults are set in `apt::params`.
-* `package_name`: The package that provides the `apt-add-repository` command. OS-dependent defaults are set in `apt::params`.
-* `package_manage`: Whether or not to manage the package providing `apt-add-repository`. Defaults to true.
-
-### 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:
+<a id="replace-the-default-sourceslist-file"></a>
+
+### Replace the default `sources.list` file
+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.
+
+```puppet
+apt::source { "archive.ubuntu.com-${facts['os']['distro']['codename']}":
+ location => 'http://archive.ubuntu.com/ubuntu',
+ key => '630239CC130E1A7FD81A27B140976EAF437D05B5',
+ repos => 'main universe multiverse restricted',
+}
+
+apt::source { "archive.ubuntu.com-${facts['os']['distro']['codename']}-security":
+ location => 'http://archive.ubuntu.com/ubuntu',
+ key => '630239CC130E1A7FD81A27B140976EAF437D05B5',
+ repos => 'main universe multiverse restricted',
+ release => "${facts['os']['distro']['codename']}-security"
+}
+
+apt::source { "archive.ubuntu.com-${facts['os']['distro']['codename']}-updates":
+ location => 'http://archive.ubuntu.com/ubuntu',
+ key => '630239CC130E1A7FD81A27B140976EAF437D05B5',
+ repos => 'main universe multiverse restricted',
+ release => "${facts['os']['distro']['codename']}-updates"
+}
+
+apt::source { "archive.ubuntu.com-${facts['os']['distro']['codename']}-backports":
+ location => 'http://archive.ubuntu.com/ubuntu',
+ key => '630239CC130E1A7FD81A27B140976EAF437D05B5',
+ repos => 'main universe multiverse restricted',
+ release => "${facts['os']['distro']['codename']}-backports"
+}
```
-class { 'apt': }
-apt::source { 'puppetlabs':
- location => 'http://apt.puppetlabs.com',
- repos => 'main dependencies',
- key => '47B320EB4C7C375AA9DAE1A01054B7A24BD6EC30',
- key_server => 'pgp.mit.edu',
+### Manage login configuration settings for an APT source or proxy in `/etc/apt/auth.conf`
+
+Starting with APT version 1.5, you can define login configuration settings, such as
+username and password, for APT sources or proxies that require authentication
+in the `/etc/apt/auth.conf` file. This is preferable to embedding login
+information directly in `source.list` entries, which are usually world-readable.
+
+The `/etc/apt/auth.conf` file follows the format of netrc (used by ftp or
+curl) and has restrictive file permissions. See [here](https://manpages.debian.org/testing/apt/apt_auth.conf.5.en.html) for details.
+
+Use the optional `apt::auth_conf_entries` parameter to specify an array of hashes containing login configuration settings. These hashes may only contain the `machine`, `login` and `password` keys.
+
+```puppet
+class { 'apt':
+ auth_conf_entries => [
+ {
+ 'machine' => 'apt-proxy.example.net',
+ 'login' => 'proxylogin',
+ 'password' => 'proxypassword',
+ },
+ {
+ 'machine' => 'apt.example.com/ubuntu',
+ 'login' => 'reader',
+ 'password' => 'supersecret',
+ },
+ ],
}
-```
+```
+
+<a id="reference"></a>
+
+## Reference
+
+### Facts
+
+* `apt_updates`: The number of installed packages with available updates from `upgrade`.
+
+* `apt_dist_updates`: The number of installed packages with available updates from `dist-upgrade`.
+
+* `apt_security_updates`: The number of installed packages with available security updates from `upgrade`.
+
+* `apt_security_dist_updates`: The number of installed packages with available security updates from `dist-upgrade`.
+
+* `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.
+
+* `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.
+
+* `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).
+
+* `apt_reboot_required`: Determines if a reboot is necessary after updates have been installed.
+
+### More Information
+
+See [REFERENCE.md](https://github.com/puppetlabs/puppetlabs-apt/blob/main/REFERENCE.md) for all other reference documentation.
+
+<a id="limitations"></a>
+
+## Limitations
+
+This module is not designed to be split across [run stages](https://docs.puppetlabs.com/puppet/latest/reference/lang_run_stages.html).
+
+For an extensive list of supported operating systems, see [metadata.json](https://github.com/puppetlabs/puppetlabs-apt/blob/main/metadata.json)
+
+### Adding new sources or PPAs
+
+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']`, as well as 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). Before running the command below, ensure that all packages have the provider set to apt.
+
+```puppet
+Class['apt::update'] -> Package <| provider == 'apt' |>
+```
+
+## Development
-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.
+Acceptance tests for this module leverage [puppet_litmus](https://github.com/puppetlabs/puppet_litmus).
+To run the acceptance tests follow the instructions [here](https://puppetlabs.github.io/litmus/Running-acceptance-tests.html).
+You can also find a tutorial and walkthrough of using Litmus and the PDK on [YouTube](https://www.youtube.com/watch?v=FYfR7ZEGHoE).
-Check your smoke test for syntax errors:
+If you run into an issue with this module, or if you would like to request a feature, please [file a ticket](https://tickets.puppetlabs.com/browse/MODULES/).
+Every Monday the Puppet IA Content Team has [office hours](https://puppet.com/community/office-hours) in the [Puppet Community Slack](http://slack.puppet.com/), alternating between an EMEA friendly time (1300 UTC) and an Americas friendly time (0900 Pacific, 1700 UTC).
-`$ puppet parser validate tests/puppetlabs-apt.pp`
+If you have problems getting this module up and running, please [contact Support](http://puppetlabs.com/services/customer-support).
-If you receive no output from that command, it means nothing is wrong. Then, apply the code:
+If you submit a change to this module, be sure to regenerate the reference documentation as follows:
+```bash
+puppet strings generate --format markdown --out REFERENCE.md
```
-$ 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.
-
-Limitations
------------
-
-This module should work across all versions of Debian/Ubuntu and support all major Apt repository management features.
-
-Development
-------------
-
-Puppet Labs modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can't access the huge number of platforms and myriad of 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.
-
-You can read the complete module contribution guide [on the Puppet Labs wiki.](http://projects.puppetlabs.com/projects/module-site/wiki/Module_contributing)
-
-License
--------
-
-The original code for this module comes from Evolving Web and was licensed under the MIT license. Code added since the fork of this module is licensed under the Apache 2.0 License like the rest of the Puppet Labs products.
-
-The LICENSE contains both licenses.
-
-Contributors
-------------
-
-A lot of great people have contributed to this module. A somewhat current list follows:
-
-* Ben Godfrey <ben.godfrey@wonga.com>
-* Branan Purvine-Riley <branan@puppetlabs.com>
-* Christian G. Warden <cwarden@xerus.org>
-* Dan Bode <bodepd@gmail.com> <dan@puppetlabs.com>
-* Daniel Tremblay <github@danieltremblay.ca>
-* Garrett Honeycutt <github@garretthoneycutt.com>
-* Jeff Wallace <jeff@evolvingweb.ca> <jeff@tjwallace.ca>
-* Ken Barber <ken@bob.sh>
-* Matthaus Litteken <matthaus@puppetlabs.com> <mlitteken@gmail.com>
-* Matthias Pigulla <mp@webfactory.de>
-* Monty Taylor <mordred@inaugust.com>
-* Peter Drake <pdrake@allplayers.com>
-* Reid Vandewiele <marut@cat.pdx.edu>
-* Robert Navarro <rnavarro@phiivo.com>
-* Ryan Coleman <ryan@puppetlabs.com>
-* Scott McLeod <scott.mcleod@theice.com>
-* Spencer Krum <spencer@puppetlabs.com>
-* William Van Hevelingen <blkperl@cat.pdx.edu> <wvan13@gmail.com>
-* Zach Leslie <zach@puppetlabs.com>
-* Daniele Sluijters <github@daenney.net>
-* Daniel Paulus <daniel@inuits.eu>
-* Wolf Noble <wolf@wolfspyre.com>
Code Review / puppet-modules / puppetlabs-apt.git / blobdiff