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` 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:
 100
 101 ```puppet
 102 class { 'apt':
 103   update => {
 104     frequency => 'daily',
 105     loglevel  => 'debug',
 106   },
 107 }
 108 ```
 109
 110 <a id="pin-a-specific-release"></a>
 111 ### Pin a specific release
 112
 113 ```puppet
 114 apt::pin { 'karmic': priority => 700 }
 115 apt::pin { 'karmic-updates': priority => 700 }
 116 apt::pin { 'karmic-security': priority => 700 }
 117 ```
 118
 119 You can also specify more complex pins using distribution properties:
 120
 121 ```puppet
 122 apt::pin { 'stable':
 123   priority        => -10,
 124   originator      => 'Debian',
 125   release_version => '3.0',
 126   component       => 'main',
 127   label           => 'Debian'
 128 }
 129 ```
 130
 131 To pin multiple packages, pass them to the `packages` parameter as an array or a space-delimited string.
 132
 133 <a id="add-a-personal-package-archive-repository"></a>
 134 ### Add a Personal Package Archive (PPA) repository
 135
 136 ```puppet
 137 apt::ppa { 'ppa:drizzle-developers/ppa': }
 138 ```
 139
 140 ### Add an Apt source to `/etc/apt/sources.list.d/`
 141
 142 ```puppet
 143 apt::source { 'debian_unstable':
 144   comment  => 'This is the iWeb Debian unstable mirror',
 145   location => 'http://debian.mirror.iweb.ca/debian/',
 146   release  => 'unstable',
 147   repos    => 'main contrib non-free',
 148   pin      => '-10',
 149   key      => {
 150     'id'     => 'A1BD8E9D78F7FE5C3E65D8AF8B48AD6246925553',
 151     'server' => 'subkeys.pgp.net',
 152   },
 153   include  => {
 154     'src' => true,
 155     'deb' => true,
 156   },
 157 }
 158 ```
 159
 160 To use the Puppet Apt repository as a source:
 161
 162 ```puppet
 163 apt::source { 'puppetlabs':
 164   location => 'http://apt.puppetlabs.com',
 165   repos    => 'main',
 166   key      => {
 167     'id'     => '6F6B15509CF8E59E6E469F327F438280EF8D349F',
 168     'server' => 'pgp.mit.edu',
 169   },
 170 }
 171 ```
 172
 173 <a id="configure-apt-from-hiera"></a>
 174 ### Configure Apt from Hiera
 175
 176 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.
 177
 178 ```yaml
 179 apt::sources:
 180   'debian_unstable':
 181     comment: 'This is the iWeb Debian unstable mirror'
 182     location: 'http://debian.mirror.iweb.ca/debian/'
 183     release: 'unstable'
 184     repos: 'main contrib non-free'
 185     pin: '-10'
 186     key:
 187       id: 'A1BD8E9D78F7FE5C3E65D8AF8B48AD6246925553'
 188       server: 'subkeys.pgp.net'
 189     include:
 190       src: true
 191       deb: true
 192
 193   'puppetlabs':
 194     location: 'http://apt.puppetlabs.com'
 195     repos: 'main'
 196     key:
 197       id: '6F6B15509CF8E59E6E469F327F438280EF8D349F'
 198       server: 'pgp.mit.edu'
 199 ```
 200
 201 <a id="replace-the-default-sourceslist-file"></a>
 202 ### Replace the default `sources.list` file
 203
 204 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.
 205
 206 ```puppet
 207 apt::source { "archive.ubuntu.com-${lsbdistcodename}":
 208   location => 'http://archive.ubuntu.com/ubuntu',
 209   key      => '630239CC130E1A7FD81A27B140976EAF437D05B5',
 210   repos    => 'main universe multiverse restricted',
 211 }
 212
 213 apt::source { "archive.ubuntu.com-${lsbdistcodename}-security":
 214   location => 'http://archive.ubuntu.com/ubuntu',
 215   key      => '630239CC130E1A7FD81A27B140976EAF437D05B5',
 216   repos    => 'main universe multiverse restricted',
 217   release  => "${lsbdistcodename}-security"
 218 }
 219
 220 apt::source { "archive.ubuntu.com-${lsbdistcodename}-updates":
 221   location => 'http://archive.ubuntu.com/ubuntu',
 222   key      => '630239CC130E1A7FD81A27B140976EAF437D05B5',
 223   repos    => 'main universe multiverse restricted',
 224   release  => "${lsbdistcodename}-updates"
 225 }
 226
 227 apt::source { "archive.ubuntu.com-${lsbdistcodename}-backports":
 228  location => 'http://archive.ubuntu.com/ubuntu',
 229  key      => '630239CC130E1A7FD81A27B140976EAF437D05B5',
 230  repos    => 'main universe multiverse restricted',
 231  release  => "${lsbdistcodename}-backports"
 232 }
 233 ```
 234
 235 ### Manage login configuration settings for an APT source or proxy in `/etc/apt/auth.conf`
 236
 237 Starting with APT version 1.5, you can define login configuration settings, such as
 238 username and password, for APT sources or proxies that require authentication
 239 in the `/etc/apt/auth.conf` file. This is preferable to embedding login
 240 information directly in `source.list` entries, which are usually world-readable.
 241
 242 The `/etc/apt/auth.conf` file follows the format of netrc (used by ftp or
 243 curl) and has restrictive file permissions. See [here](https://manpages.debian.org/testing/apt/apt_auth.conf.5.en.html) for details.
 244
 245 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.
 246
 247 ```puppet
 248 class { 'apt':
 249   auth_conf_entries => [
 250     {
 251       'machine'  => 'apt-proxy.example.net',
 252       'login'    => 'proxylogin',
 253       'password' => 'proxypassword',
 254     },
 255     {
 256       'machine'  => 'apt.example.com/ubuntu',
 257       'login'    => 'reader',
 258       'password' => 'supersecret',
 259     },
 260   ],
 261 }
 262 ```
 263
 264 <a id="reference"></a>
 265 ## Reference
 266
 267 ### Facts
 268
 269 * `apt_updates`: The number of installed packages with available updates from `upgrade`.
 270
 271 * `apt_dist_updates`: The number of installed packages with available updates from `dist-upgrade`.
 272
 273 * `apt_security_updates`: The number of installed packages with available security updates from `upgrade`.
 274
 275 * `apt_security_dist_updates`: The number of installed packages with available security updates from `dist-upgrade`.
 276
 277 * `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.
 278
 279 * `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.
 280
 281 * `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).
 282
 283 * `apt_reboot_required`: Determines if a reboot is necessary after updates have been installed.
 284
 285 ### More Information
 286
 287 See [REFERENCE.md](https://github.com/puppetlabs/puppetlabs-apt/blob/master/REFERENCE.md) for all other reference documentation.
 288
 289 <a id="limitations"></a>
 290 ## Limitations
 291
 292 This module is not designed to be split across [run stages](https://docs.puppetlabs.com/puppet/latest/reference/lang_run_stages.html).
 293
 294 For an extensive list of supported operating systems, see [metadata.json](https://github.com/puppetlabs/puppetlabs-apt/blob/master/metadata.json)
 295
 296 ### Adding new sources or PPAs
 297
 298 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.
 299
 300 ```puppet
 301 Class['apt::update'] -> Package <| provider == 'apt' |>
 302 ```
 303
 304 ## Development
 305
 306 Acceptance tests for this module leverage [puppet_litmus](https://github.com/puppetlabs/puppet_litmus).
 307 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).
 308 You can also find a tutorial and walkthrough of using Litmus and the PDK on [YouTube](https://www.youtube.com/watch?v=FYfR7ZEGHoE).
 309
 310 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/).
 311 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).
 312
 313 If you have problems getting this module up and running, please [contact Support](http://puppetlabs.com/services/customer-support).
 314
 315 If you submit a change to this module, be sure to regenerate the reference documentation as follows:
 316
 317 ```bash
 318 puppet strings generate --format markdown --out REFERENCE.md
 319 ```