-apt
-===
+# apt
-[](https://travis-ci.org/puppetlabs/puppetlabs-apt)
+#### Table of Contents
-## Description
+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)
-Provides helpful definitions for dealing with Apt.
+<a id="module-description"></a>
-=======
+## Module Description
-Overview
---------
+The apt module lets you use Puppet to manage APT (Advanced Package Tool) sources, keys, and other configuration options.
-The APT module provides a simple interface for managing APT source, key, and definitions with Puppet.
+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.
-Module Description
-------------------
+**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.
-APT automates obtaining and installing software packages on \*nix systems.
+<a id="setup"></a>
-Setup
------
+## Setup
-**What APT affects:**
+<a id="what-apt-affects"></a>
-* package/service/configuration files for APT
-* 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
+### What apt affects
-### Beginning with APT
+* 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
-To begin using the APT module with default parameters, declare the class
+**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`.
- include apt
+<a id="beginning-with-apt"></a>
-Puppet code that uses anything from the APT module requires that the core apt class be declared/\s\+$//e
+### Beginning with apt
-Usage
------
+To use the apt module with default parameters, declare the `apt` class.
-Using the APT module consists predominantly in declaring classes that provide desired functionality and features.
+```puppet
+include apt
+```
-### apt
+**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.
-`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.
+<a id="usage"></a>
-The parameters for `apt` are not required in general and are predominantly for development environment use-cases.
+## Usage
- 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
- }
+<a id="add-gpg-keys"></a>
-Puppet will manage your system's `sources.list` file and `sources.list.d` directory but will do its best to respect existing content.
+### Add GPG keys
-If you declare your apt class with `purge_sources_list` and `purge_sources_list_d` set to 'true', Puppet will unapologetically purge any existing content it finds that wasn't declared with Puppet.
+**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::builddep
+Declare the `apt::key` defined type:
-Installs the build depends of a specified package.
+```puppet
+apt::key { 'puppetlabs':
+ id => '6F6B15509CF8E59E6E469F327F438280EF8D349F',
+ server => 'pgp.mit.edu',
+ options => 'http-proxy="http://proxyuser:proxypass@example.org:3128"',
+}
+```
- apt::builddep { 'glusterfs-server': }
+<a id="prioritize-backports"></a>
-### apt::force
+### Prioritize backports
-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.
+```puppet
+class { 'apt::backports':
+ pin => 500,
+}
+```
- apt::force { 'glusterfs-server':
- release => 'unstable',
- version => '3.0.3',
- require => Apt::Source['debian_unstable'],
- }
+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 => '4BD6EC30',
- }
+### 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 it is a native type it can be used in and queried for 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:
-### apt::key
+```puppet
+class { 'apt':
+ update => {
+ frequency => 'daily',
+ loglevel => 'debug',
+ },
+}
+```
-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.
+> **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::key { 'puppetlabs':
- key => '4BD6EC30',
- key_server => 'pgp.mit.edu',
- }
+<a id="pin-a-specific-release"></a>
- apt::key { 'jenkins':
- key => 'D50582E6',
- key_source => 'http://pkg.jenkins-ci.org/debian/jenkins-ci.org.key',
- }
+### Pin a specific release
-### apt::pin
+```puppet
+apt::pin { 'karmic': priority => 700 }
+apt::pin { 'karmic-updates': priority => 700 }
+apt::pin { 'karmic-security': priority => 700 }
+```
-Adds an apt pin for a certain release.
+You can also specify more complex pins using distribution properties:
- apt::pin { 'karmic': priority => 700 }
- apt::pin { 'karmic-updates': priority => 700 }
- apt::pin { 'karmic-security': priority => 700 }
+```puppet
+apt::pin { 'stable':
+ priority => -10,
+ originator => 'Debian',
+ release_version => '3.0',
+ component => 'main',
+ label => 'Debian'
+}
+```
-Note you can also specifying more complex pins using distribution properties.
+To pin multiple packages, pass them to the `packages` parameter as an array or a space-delimited string.
- apt::pin { 'stable':
- priority => -10,
- originator => 'Debian',
- release_version => '3.0',
- component => 'main',
- label => 'Debian'
- }
+<a id="add-a-personal-package-archive-repository"></a>
-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.
+### Add a Personal Package Archive (PPA) repository
-### apt::hold
+```puppet
+apt::ppa { 'ppa:drizzle-developers/ppa': }
+```
-When you wish to hold a package in Puppet is 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'.
+### Add an Apt source to `/etc/apt/sources.list.d/`
-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`.
+```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,
+ },
+}
+```
+
+To use the Puppet Apt repository as a source:
-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.
+```puppet
+apt::source { 'puppetlabs':
+ location => 'http://apt.puppetlabs.com',
+ repos => 'main',
+ key => {
+ 'id' => '6F6B15509CF8E59E6E469F327F438280EF8D349F',
+ 'server' => 'pgp.mit.edu',
+ },
+}
+```
+
+<a id="configure-apt-from-hiera"></a>
-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'.
+### Configure Apt from Hiera
-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:
+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.
- 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:
-
- apt::hold { 'vim':
- version => '2:7.3.*',
- }
-
-### apt::ppa
+```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'
+ pin: '-10'
+ key:
+ id: 'A1BD8E9D78F7FE5C3E65D8AF8B48AD6246925553'
+ server: 'subkeys.pgp.net'
+ include:
+ src: true
+ deb: true
-Adds a ppa repository using `add-apt-repository`.
+ 'puppetlabs':
+ location: 'http://apt.puppetlabs.com'
+ repos: 'main'
+ key:
+ id: '6F6B15509CF8E59E6E469F327F438280EF8D349F'
+ server: 'pgp.mit.edu'
+```
- apt::ppa { 'ppa:drizzle-developers/ppa': }
+<a id="replace-the-default-sourceslist-file"></a>
-### apt::release
+### Replace the default `sources.list` file
-Sets the default apt release. This class is particularly useful when using repositories, like Debian, that are unstable in Ubuntu.
+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.
- class { 'apt::release':
- release_id => 'precise',
- }
+```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
+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"
+}
-Adds an apt source to `/etc/apt/sources.list.d/`.
+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 { 'debian_unstable':
- location => 'http://debian.mirror.iweb.ca/debian/',
- release => 'unstable',
- repos => 'main contrib non-free',
- required_packages => 'debian-keyring debian-archive-keyring',
- key => '46925553',
- key_server => 'subkeys.pgp.net',
- pin => '-10',
- include_src => true
- }
+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"
+}
+```
-If you would like to configure your system so the source is the Puppet Labs APT repository
+### Manage login configuration settings for an APT source or proxy in `/etc/apt/auth.conf`
- apt::source { 'puppetlabs':
- location => 'http://apt.puppetlabs.com',
- repos => 'main',
- key => '4BD6EC30',
- key_server => 'pgp.mit.edu',
- }
+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.
-#### 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: '55BE302B'
- key_server: 'subkeys.pgp.net'
- pin: '-10'
- include_src: 'true'
+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.
- 'puppetlabs':
- location: 'http://apt.puppetlabs.com'
- repos: 'main'
- key: '4BD6EC30'
- key_server: 'pgp.mit.edu'
-</pre>
+```puppet
+class { 'apt':
+ auth_conf_entries => [
+ {
+ 'machine' => 'apt-proxy.example.net',
+ 'login' => 'proxylogin',
+ 'password' => 'proxypassword',
+ },
+ {
+ 'machine' => 'apt.example.com/ubuntu',
+ 'login' => 'reader',
+ 'password' => 'supersecret',
+ },
+ ],
+}
+```
-### Testing
+<a id="reference"></a>
-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.
+## Reference
-#### Example Test
+### Facts
-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
+* `apt_updates`: The number of installed packages with available updates from `upgrade`.
- apt::source { 'puppetlabs':
- location => 'http://apt.puppetlabs.com',
- repos => 'main',
- key => '4BD6EC30',
- key_server => 'pgp.mit.edu',
- }
+* `apt_dist_updates`: The number of installed packages with available updates from `dist-upgrade`.
-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.
+* `apt_security_updates`: The number of installed packages with available security updates from `upgrade`.
-Check your smoke test for syntax errors
+* `apt_security_dist_updates`: The number of installed packages with available security updates from `dist-upgrade`.
- $ puppet parser validate tests/puppetlabs-apt.pp
+* `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.
-If you receive no output from that command, it means nothing is wrong. Then apply the code
+* `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.
- $ 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_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).
-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.
+* `apt_reboot_required`: Determines if a reboot is necessary after updates have been installed.
-Implementation
---------------
+### More Information
-### apt::backports
+See [REFERENCE.md](https://github.com/puppetlabs/puppetlabs-apt/blob/main/REFERENCE.md) for all other reference documentation.
-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).
+<a id="limitations"></a>
-Limitations
------------
+## Limitations
-This module should work across all versions of Debian/Ubuntu and support all major APT repository management features.
+This module is not designed to be split across [run stages](https://docs.puppetlabs.com/puppet/latest/reference/lang_run_stages.html).
-Development
-------------
+For an extensive list of supported operating systems, see [metadata.json](https://github.com/puppetlabs/puppetlabs-apt/blob/main/metadata.json)
-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.
+### Adding new sources or PPAs
-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.
+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.
-You can read the complete module contribution guide [on the Puppet Labs wiki.](http://projects.puppetlabs.com/projects/module-site/wiki/Module_contributing)
+```puppet
+Class['apt::update'] -> Package <| provider == 'apt' |>
+```
-License
--------
+## Development
-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.
+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).
-The LICENSE contains both licenses.
+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).
-Contributors
-------------
+If you have problems getting this module up and running, please [contact Support](http://puppetlabs.com/services/customer-support).
-A lot of great people have contributed to this module. A somewhat current list follows:
+If you submit a change to this module, be sure to regenerate the reference documentation as 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>
+```bash
+puppet strings generate --format markdown --out REFERENCE.md
+```
Code Review / puppet-modules / puppetlabs-apt.git / blobdiff