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