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 ## Module Description
  23
  24 The apt module lets you use Puppet to manage Apt sources, keys, and other configuration options.
  25
  26 Apt (Advanced Package Tool) 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.
  27
  28 **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.
  29
  30 ## Setup
  31
  32 ### What apt affects
  33
  34 * Your system's `preferences` file and `preferences.d` directory
  35 * Your system's `sources.list` file and `sources.list.d` directory
  36 * System repositories
  37 * Authentication keys
  38
  39 **Note:** This module offers `purge` parameters which, if set to `true`, **destroy** any configuration on the node's `sources.list(.d)` and `preferences(.d)` that you haven't declared through Puppet. The default for these parameters is `false`.
  40
  41 ### Beginning with apt
  42
  43 To use the apt module with default parameters, declare the `apt` class.
  44
  45 ```puppet
  46 include apt
  47 ```
  48
  49 **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.
  50
  51 ## Usage
  52
  53 ### Add GPG keys
  54
  55 **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.
  56
  57 Declare the `apt::key` defined type:
  58
  59 ```puppet
  60 apt::key { 'puppetlabs':
  61   id      => '6F6B15509CF8E59E6E469F327F438280EF8D349F',
  62   server  => 'pgp.mit.edu',
  63   options => 'http-proxy="http://proxyuser:proxypass@example.org:3128"',
  64 }
  65 ```
  66
  67 ### Prioritize backports
  68
  69 ```puppet
  70 class { 'apt::backports':
  71   pin => 500,
  72 }
  73 ```
  74
  75 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.
  76
  77 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.
  78
  79 ### Update the list of packages
  80
  81 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':
  82
  83 ```puppet
  84 class { 'apt':
  85   update => {
  86     frequency => 'daily',
  87   },
  88 }
  89 ```
  90 When `Exec['apt_update']` is triggered, it generates a `Notice` message. Because the default [logging level for agents](https://docs.puppet.com/puppet/latest/configuration.html#loglevel) is `notice`, this causes the repository update to appear in logs and agent reports. Some tools, such as [The Foreman](https://www.theforeman.org), report the update notice as a significant change. To eliminate these updates from reports, set the [loglevel](https://docs.puppet.com/puppet/latest/metaparameter.html#loglevel) metaparameter for `Exec['apt_update']` above the agent logging level:
  91
  92 ```puppet
  93 class { 'apt':
  94   update => {
  95     frequency => 'daily',
  96     loglevel  => 'debug',
  97   },
  98 }
  99 ```
 100
 101 ### Pin a specific release
 102
 103 ```puppet
 104 apt::pin { 'karmic': priority => 700 }
 105 apt::pin { 'karmic-updates': priority => 700 }
 106 apt::pin { 'karmic-security': priority => 700 }
 107 ```
 108
 109 You can also specify more complex pins using distribution properties:
 110
 111 ```puppet
 112 apt::pin { 'stable':
 113   priority        => -10,
 114   originator      => 'Debian',
 115   release_version => '3.0',
 116   component       => 'main',
 117   label           => 'Debian'
 118 }
 119 ```
 120
 121 To pin multiple packages, pass them to the `packages` parameter as an array or a space-delimited string.
 122
 123 ### Add a Personal Package Archive repository
 124
 125 ```puppet
 126 apt::ppa { 'ppa:drizzle-developers/ppa': }
 127 ```
 128
 129 ### Add an Apt source to `/etc/apt/sources.list.d/`
 130
 131 ```puppet
 132 apt::source { 'debian_unstable':
 133   comment  => 'This is the iWeb Debian unstable mirror',
 134   location => 'http://debian.mirror.iweb.ca/debian/',
 135   release  => 'unstable',
 136   repos    => 'main contrib non-free',
 137   pin      => '-10',
 138   key      => {
 139     'id'     => 'A1BD8E9D78F7FE5C3E65D8AF8B48AD6246925553',
 140     'server' => 'subkeys.pgp.net',
 141   },
 142   include  => {
 143     'src' => true,
 144     'deb' => true,
 145   },
 146 }
 147 ```
 148
 149 To use the Puppet Apt repository as a source:
 150
 151 ```puppet
 152 apt::source { 'puppetlabs':
 153   location => 'http://apt.puppetlabs.com',
 154   repos    => 'main',
 155   key      => {
 156     'id'     => '6F6B15509CF8E59E6E469F327F438280EF8D349F',
 157     'server' => 'pgp.mit.edu',
 158   },
 159 }
 160 ```
 161
 162 ### Configure Apt from Hiera
 163
 164 Instead of specifying your sources directly as resources, you can instead just
 165 include the `apt` class, which will pick up the values automatically from
 166 hiera.
 167
 168 ```yaml
 169 apt::sources:
 170   'debian_unstable':
 171     comment: 'This is the iWeb Debian unstable mirror'
 172     location: 'http://debian.mirror.iweb.ca/debian/'
 173     release: 'unstable'
 174     repos: 'main contrib non-free'
 175     pin: '-10'
 176     key:
 177       id: 'A1BD8E9D78F7FE5C3E65D8AF8B48AD6246925553'
 178       server: 'subkeys.pgp.net'
 179     include:
 180       src: true
 181       deb: true
 182
 183   'puppetlabs':
 184     location: 'http://apt.puppetlabs.com'
 185     repos: 'main'
 186     key:
 187       id: '6F6B15509CF8E59E6E469F327F438280EF8D349F'
 188       server: 'pgp.mit.edu'
 189 ```
 190
 191 ### Replace the default `sources.list` file
 192
 193 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.
 194
 195 ```puppet
 196 apt::source { "archive.ubuntu.com-${lsbdistcodename}":
 197   location => 'http://archive.ubuntu.com/ubuntu',
 198   key      => '630239CC130E1A7FD81A27B140976EAF437D05B5',
 199   repos    => 'main universe multiverse restricted',
 200 }
 201
 202 apt::source { "archive.ubuntu.com-${lsbdistcodename}-security":
 203   location => 'http://archive.ubuntu.com/ubuntu',
 204   key      => '630239CC130E1A7FD81A27B140976EAF437D05B5',
 205   repos    => 'main universe multiverse restricted',
 206   release  => "${lsbdistcodename}-security"
 207 }
 208
 209 apt::source { "archive.ubuntu.com-${lsbdistcodename}-updates":
 210   location => 'http://archive.ubuntu.com/ubuntu',
 211   key      => '630239CC130E1A7FD81A27B140976EAF437D05B5',
 212   repos    => 'main universe multiverse restricted',
 213   release  => "${lsbdistcodename}-updates"
 214 }
 215
 216 apt::source { "archive.ubuntu.com-${lsbdistcodename}-backports":
 217  location => 'http://archive.ubuntu.com/ubuntu',
 218  key      => '630239CC130E1A7FD81A27B140976EAF437D05B5',
 219  repos    => 'main universe multiverse restricted',
 220  release  => "${lsbdistcodename}-backports"
 221 }
 222 ```
 223
 224 ### Manage login configuration settings for an APT source or proxy in `/etc/apt/auth.conf`
 225
 226 Starting with APT version 1.5, you can define login configuration settings, such as
 227 username and password, for APT sources or proxies that require authentication
 228 in the `/etc/apt/auth.conf` file. This is preferable to embedding login
 229 information directly in `source.list` entries, which are usually world-readable.
 230
 231 The `/etc/apt/auth.conf` file follows the format of netrc (used by ftp or
 232 curl) and has restrictive file permissions. See
 233 https://manpages.debian.org/testing/apt/apt_auth.conf.5.en.html for details.
 234
 235 Use the optional `apt::auth_conf_entries` parameter to specify an array of
 236 hashes containing login configuration settings. These hashes may only contain
 237 the `machine`, `login` and `password` keys.
 238
 239 ```puppet
 240 class { 'apt':
 241   auth_conf_entries => [
 242     {
 243       'machine'  => 'apt-proxy.example.net',
 244       'login'    => 'proxylogin',
 245       'password' => 'proxypassword',
 246     },
 247     {
 248       'machine'  => 'apt.example.com/ubuntu',
 249       'login'    => 'reader',
 250       'password' => 'supersecret',
 251     },
 252   ],
 253 }
 254 ```
 255
 256 ## Reference
 257
 258 ### Facts
 259
 260 * `apt_updates`: The number of installed packages with available updates from `upgrade`.
 261
 262 * `apt_dist_updates`: The number of installed packages with available updates from `dist-upgrade`.
 263
 264 * `apt_security_updates`: The number of installed packages with available security updates from `upgrade`.
 265
 266 * `apt_security_dist_updates`: The number of installed packages with available security updates from `dist-upgrade`.
 267
 268 * `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.
 269
 270 * `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.
 271
 272 * `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).
 273
 274 * `apt_reboot_required`: Determines if a reboot is necessary after updates have been installed.
 275
 276 ### More Information
 277
 278 See [REFERENCE.md](https://github.com/puppetlabs/puppetlabs-motd/blob/master/REFERENCE.md) for all other reference documentation.
 279
 280 ## Limitations
 281
 282 This module is not designed to be split across [run stages](https://docs.puppetlabs.com/puppet/latest/reference/lang_run_stages.html).
 283
 284 For an extensive list of supported operating systems, see [metadata.json](https://github.com/puppetlabs/puppetlabs-apt/blob/master/metadata.json)
 285
 286 ### Adding new sources or PPAs
 287
 288 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']`, in addition to 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.
 289
 290 ```puppet
 291 Class['apt::update'] -> Package <| provider == 'apt' |>
 292 ```
 293
 294 ## Development
 295
 296 Puppet 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 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.
 297
 298 For more information, see our [module contribution guide.](https://docs.puppetlabs.com/forge/contributing.html)
 299
 300 To see who's already involved, see the [list of contributors.](https://github.com/puppetlabs/puppetlabs-apt/graphs/contributors)