README.md

   1 # apt
   2
   3 #### Table of Contents
   4
   5
   6 1. [Module Description - What the module does and why it is useful](#module-description)
   7 1. [Setup - The basics of getting started with apt](#setup)
   8     * [What apt affects](#what-apt-affects)
   9     * [Beginning with apt](#beginning-with-apt)
  10 1. [Usage - Configuration options and additional functionality](#usage)
  11     * [Add GPG keys](#add-gpg-keys)
  12     * [Prioritize backports](#prioritize-backports)
  13     * [Update the list of packages](#update-the-list-of-packages)
  14     * [Pin a specific release](#pin-a-specific-release)
  15     * [Add a Personal Package Archive repository](#add-a-personal-package-archive-repository)
  16     * [Configure Apt from Hiera](#configure-apt-from-hiera)
  17     * [Replace the default sources.list file](#replace-the-default-sourceslist-file)
  18 1. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
  19 1. [Limitations - OS compatibility, etc.](#limitations)
  20 1. [Development - Guide for contributing to the module](#development)
  21
  22 <a id="module-description"></a>
  23 ## Module Description
  24
  25 The apt module lets you use Puppet to manage APT (Advanced Package Tool) sources, keys, and other configuration options.
  26
  27 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.
  28
  29 **Note**: 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. We highly recommend you either make this part of your provisioning layer, if you run many Debian or derivative systems, or ensure that you have Facter 2.2.0 or later installed, which will pull this dependency in for you.
  30
  31 <a id="setup"></a>
  32 ## Setup
  33
  34 <a id="what-apt-affects"></a>
  35 ### What apt affects
  36
  37 * Your system's `preferences` file and `preferences.d` directory
  38 * Your system's `sources.list` file and `sources.list.d` directory
  39 * Your system's `apt.conf.d` directory
  40 * System repositories
  41 * Authentication keys
  42
  43 **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`.
  44
  45 <a id="beginning-with-apt"></a>
  46 ### Beginning with apt
  47
  48 To use the apt module with default parameters, declare the `apt` class.
  49
  50 ```puppet
  51 include apt
  52 ```
  53
  54 **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.
  55
  56 <a id="usage"></a>
  57 ## Usage
  58
  59 <a id="add-gpg-keys"></a>
  60 ### Add GPG keys
  61
  62 **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.
  63
  64 Declare the `apt::key` defined type:
  65
  66 ```puppet
  67 apt::key { 'puppetlabs':
  68   id      => '6F6B15509CF8E59E6E469F327F438280EF8D349F',
  69   server  => 'pgp.mit.edu',
  70   options => 'http-proxy="http://proxyuser:proxypass@example.org:3128"',
  71 }
  72 ```
  73
  74 <a id="prioritize-backports"></a>
  75 ### Prioritize backports
  76
  77 ```puppet
  78 class { 'apt::backports':
  79   pin => 500,
  80 }
  81 ```
  82
  83 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.
  84
  85 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.
  86
  87 <a id="update-the-list-of-packages"></a>
  88 ### Update the list of packages
  89
  90 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':
  91
  92 ```puppet
  93 class { 'apt':
  94   update => {
  95     frequency => 'daily',
  96   },
  97 }
  98 ```
  99 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:
 100
 101 ```puppet
 102 class { 'apt':
 103   update => {
 104     frequency => 'daily',
 105     loglevel  => 'debug',
 106   },
 107 }
 108 ```
 109
 110 > **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).
 111
 112 <a id="pin-a-specific-release"></a>
 113 ### Pin a specific release
 114
 115 ```puppet
 116 apt::pin { 'karmic': priority => 700 }
 117 apt::pin { 'karmic-updates': priority => 700 }
 118 apt::pin { 'karmic-security': priority => 700 }
 119 ```
 120
 121 You can also specify more complex pins using distribution properties:
 122
 123 ```puppet
 124 apt::pin { 'stable':
 125   priority        => -10,
 126   originator      => 'Debian',
 127   release_version => '3.0',
 128   component       => 'main',
 129   label           => 'Debian'
 130 }
 131 ```
 132
 133 To pin multiple packages, pass them to the `packages` parameter as an array or a space-delimited string.
 134
 135 <a id="add-a-personal-package-archive-repository"></a>
 136 ### Add a Personal Package Archive (PPA) repository
 137
 138 ```puppet
 139 apt::ppa { 'ppa:drizzle-developers/ppa': }
 140 ```
 141
 142 ### Add an Apt source to `/etc/apt/sources.list.d/`
 143
 144 ```puppet
 145 apt::source { 'debian_unstable':
 146   comment  => 'This is the iWeb Debian unstable mirror',
 147   location => 'http://debian.mirror.iweb.ca/debian/',
 148   release  => 'unstable',
 149   repos    => 'main contrib non-free',
 150   pin      => '-10',
 151   key      => {
 152     'id'     => 'A1BD8E9D78F7FE5C3E65D8AF8B48AD6246925553',
 153     'server' => 'subkeys.pgp.net',
 154   },
 155   include  => {
 156     'src' => true,
 157     'deb' => true,
 158   },
 159 }
 160 ```
 161
 162 To use the Puppet Apt repository as a source:
 163
 164 ```puppet
 165 apt::source { 'puppetlabs':
 166   location => 'http://apt.puppetlabs.com',
 167   repos    => 'main',
 168   key      => {
 169     'id'     => '6F6B15509CF8E59E6E469F327F438280EF8D349F',
 170     'server' => 'pgp.mit.edu',
 171   },
 172 }
 173 ```
 174
 175 <a id="configure-apt-from-hiera"></a>
 176 ### Configure Apt from Hiera
 177
 178 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.
 179
 180 ```yaml
 181 apt::sources:
 182   'debian_unstable':
 183     comment: 'This is the iWeb Debian unstable mirror'
 184     location: 'http://debian.mirror.iweb.ca/debian/'
 185     release: 'unstable'
 186     repos: 'main contrib non-free'
 187     pin: '-10'
 188     key:
 189       id: 'A1BD8E9D78F7FE5C3E65D8AF8B48AD6246925553'
 190       server: 'subkeys.pgp.net'
 191     include:
 192       src: true
 193       deb: true
 194
 195   'puppetlabs':
 196     location: 'http://apt.puppetlabs.com'
 197     repos: 'main'
 198     key:
 199       id: '6F6B15509CF8E59E6E469F327F438280EF8D349F'
 200       server: 'pgp.mit.edu'
 201 ```
 202
 203 <a id="replace-the-default-sourceslist-file"></a>
 204 ### Replace the default `sources.list` file
 205
 206 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.
 207
 208 ```puppet
 209 apt::source { "archive.ubuntu.com-${lsbdistcodename}":
 210   location => 'http://archive.ubuntu.com/ubuntu',
 211   key      => '630239CC130E1A7FD81A27B140976EAF437D05B5',
 212   repos    => 'main universe multiverse restricted',
 213 }
 214
 215 apt::source { "archive.ubuntu.com-${lsbdistcodename}-security":
 216   location => 'http://archive.ubuntu.com/ubuntu',
 217   key      => '630239CC130E1A7FD81A27B140976EAF437D05B5',
 218   repos    => 'main universe multiverse restricted',
 219   release  => "${lsbdistcodename}-security"
 220 }
 221
 222 apt::source { "archive.ubuntu.com-${lsbdistcodename}-updates":
 223   location => 'http://archive.ubuntu.com/ubuntu',
 224   key      => '630239CC130E1A7FD81A27B140976EAF437D05B5',
 225   repos    => 'main universe multiverse restricted',
 226   release  => "${lsbdistcodename}-updates"
 227 }
 228
 229 apt::source { "archive.ubuntu.com-${lsbdistcodename}-backports":
 230  location => 'http://archive.ubuntu.com/ubuntu',
 231  key      => '630239CC130E1A7FD81A27B140976EAF437D05B5',
 232  repos    => 'main universe multiverse restricted',
 233  release  => "${lsbdistcodename}-backports"
 234 }
 235 ```
 236
 237 ### Manage login configuration settings for an APT source or proxy in `/etc/apt/auth.conf`
 238
 239 Starting with APT version 1.5, you can define login configuration settings, such as
 240 username and password, for APT sources or proxies that require authentication
 241 in the `/etc/apt/auth.conf` file. This is preferable to embedding login
 242 information directly in `source.list` entries, which are usually world-readable.
 243
 244 The `/etc/apt/auth.conf` file follows the format of netrc (used by ftp or
 245 curl) and has restrictive file permissions. See [here](https://manpages.debian.org/testing/apt/apt_auth.conf.5.en.html) for details.
 246
 247 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.
 248
 249 ```puppet
 250 class { 'apt':
 251   auth_conf_entries => [
 252     {
 253       'machine'  => 'apt-proxy.example.net',
 254       'login'    => 'proxylogin',
 255       'password' => 'proxypassword',
 256     },
 257     {
 258       'machine'  => 'apt.example.com/ubuntu',
 259       'login'    => 'reader',
 260       'password' => 'supersecret',
 261     },
 262   ],
 263 }
 264 ```
 265
 266 <a id="reference"></a>
 267 ## Reference
 268
 269 ### Facts
 270
 271 * `apt_updates`: The number of installed packages with available updates from `upgrade`.
 272
 273 * `apt_dist_updates`: The number of installed packages with available updates from `dist-upgrade`.
 274
 275 * `apt_security_updates`: The number of installed packages with available security updates from `upgrade`.
 276
 277 * `apt_security_dist_updates`: The number of installed packages with available security updates from `dist-upgrade`.
 278
 279 * `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.
 280
 281 * `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.
 282
 283 * `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).
 284
 285 * `apt_reboot_required`: Determines if a reboot is necessary after updates have been installed.
 286
 287 ### More Information
 288
 289 See [REFERENCE.md](https://github.com/puppetlabs/puppetlabs-apt/blob/main/REFERENCE.md) for all other reference documentation.
 290
 291 <a id="limitations"></a>
 292 ## Limitations
 293
 294 This module is not designed to be split across [run stages](https://docs.puppetlabs.com/puppet/latest/reference/lang_run_stages.html).
 295
 296 For an extensive list of supported operating systems, see [metadata.json](https://github.com/puppetlabs/puppetlabs-apt/blob/main/metadata.json)
 297
 298 ### Adding new sources or PPAs
 299
 300 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.
 301
 302 ```puppet
 303 Class['apt::update'] -> Package <| provider == 'apt' |>
 304 ```
 305
 306 ## Development
 307
 308 Acceptance tests for this module leverage [puppet_litmus](https://github.com/puppetlabs/puppet_litmus).
 309 To run the acceptance tests follow the instructions [here](https://github.com/puppetlabs/puppet_litmus/wiki/Tutorial:-use-Litmus-to-execute-acceptance-tests-with-a-sample-module-(MoTD)#install-the-necessary-gems-for-the-module).
 310 You can also find a tutorial and walkthrough of using Litmus and the PDK on [YouTube](https://www.youtube.com/watch?v=FYfR7ZEGHoE).
 311
 312 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/).
 313 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).
 314
 315 If you have problems getting this module up and running, please [contact Support](http://puppetlabs.com/services/customer-support).
 316
 317 If you submit a change to this module, be sure to regenerate the reference documentation as follows:
 318
 319 ```bash
 320 puppet strings generate --format markdown --out REFERENCE.md
 321 ```