manifests/init.pp

   1 # @summary Main class, includes all other classes.
   2 #
   3 # @see https://docs.puppetlabs.com/references/latest/function.html#createresources for the create resource function
   4 #
   5 # @param provider
   6 #   Specifies the provider that should be used by apt::update.
   7 #
   8 # @param keyserver
   9 #   Specifies a keyserver to provide the GPG key. Valid options: a string containing a domain name or a full URL (http://, https://, or
  10 #   hkp://).
  11 #
  12 # @param key_options
  13 #   Specifies the default options for apt::key resources.
  14 #
  15 # @param ppa_options
  16 #   Supplies options to be passed to the `add-apt-repository` command.
  17 #
  18 # @param ppa_package
  19 #   Names the package that provides the `apt-add-repository` command.
  20 #
  21 # @param backports
  22 #   Specifies some of the default parameters used by apt::backports. Valid options: a hash made up from the following keys:
  23 #
  24 # @option backports [String] :location
  25 #   See apt::backports for documentation.
  26 #
  27 # @option backports [String] :repos
  28 #   See apt::backports for documentation.
  29 #
  30 # @option backports [String] :key
  31 #   See apt::backports for documentation.
  32 #
  33 # @param confs
  34 #   Creates new `apt::conf` resources. Valid options: a hash to be passed to the create_resources function linked above.
  35 #
  36 # @param update
  37 #   Configures various update settings. Valid options: a hash made up from the following keys:
  38 #
  39 # @option update [String] :frequency
  40 #   Specifies how often to run `apt-get update`. If the exec resource `apt_update` is notified, `apt-get update` runs regardless of this value.
  41 #   Valid options: 'always' (at every Puppet run); 'daily' (if the value of `apt_update_last_success` is less than current epoch time minus 86400);
  42 #   'weekly' (if the value of `apt_update_last_success` is less than current epoch time minus 604800); and 'reluctantly' (only if the exec resource
  43 #   `apt_update` is notified). Default: 'reluctantly'.
  44 #
  45 # @option update [Integer] :loglevel
  46 #   Specifies the log level of logs outputted to the console. Default: undef.
  47 #
  48 # @option update [Integer] :timeout
  49 #   Specifies how long to wait for the update to complete before canceling it. Valid options: an integer, in seconds. Default: undef.
  50 #
  51 # @option update [Integer] :tries
  52 #    Specifies how many times to retry the update after receiving a DNS or HTTP error. Default: undef.
  53 #
  54 # @param purge
  55 #   Specifies whether to purge any existing settings that aren't managed by Puppet. Valid options: a hash made up from the following keys:
  56 #
  57 # @option purge [Boolean] :sources.list
  58 #   Specifies whether to purge any unmanaged entries from sources.list. Default false.
  59 #
  60 # @option purge [Boolean] :sources.list.d
  61 #   Specifies whether to purge any unmanaged entries from sources.list.d. Default false.
  62 #
  63 # @option purge [Boolean] :preferences
  64 #   Specifies whether to purge any unmanaged entries from preferences. Default false.
  65 #
  66 # @option purge [Boolean] :preferences.d.
  67 #   Specifies whether to purge any unmanaged entries from preferences.d. Default false.
  68 #
  69 # @param proxy
  70 #   Configures Apt to connect to a proxy server. Valid options: a hash matching the locally defined type apt::proxy.
  71 #
  72 # @param sources
  73 #   Creates new `apt::source` resources. Valid options: a hash to be passed to the create_resources function linked above.
  74 #
  75 # @param keys
  76 #   Creates new `apt::key` resources. Valid options: a hash to be passed to the create_resources function linked above.
  77 #
  78 # @param ppas
  79 #   Creates new `apt::ppa` resources. Valid options: a hash to be passed to the create_resources function linked above.
  80 #
  81 # @param pins
  82 #   Creates new `apt::pin` resources. Valid options: a hash to be passed to the create_resources function linked above.
  83 #
  84 # @param settings
  85 #   Creates new `apt::setting` resources. Valid options: a hash to be passed to the create_resources function linked above.
  86 #
  87 # @param manage_auth_conf
  88 #   Specifies whether to manage the /etc/apt/auth.conf file. When true, the file will be overwritten with the entries specified in
  89 #   the auth_conf_entries parameter. When false, the file will be ignored (note that this does not set the file to absent.
  90 #
  91 # @param auth_conf_entries
  92 #   An optional array of login configuration settings (hashes) that are recorded in the file /etc/apt/auth.conf. This file has a netrc-like
  93 #   format (similar to what curl uses) and contains the login configuration for APT sources and proxies that require authentication. See
  94 #   https://manpages.debian.org/testing/apt/apt_auth.conf.5.en.html for details. If specified each hash must contain the keys machine, login and
  95 #   password and no others. Specifying manage_auth_conf and not specifying this parameter will set /etc/apt/auth.conf to absent.
  96 #
  97 # @param auth_conf_owner
  98 #   The owner of the file /etc/apt/auth.conf. Default: '_apt' or 'root' on old releases.
  99 #
 100 # @param root
 101 #   Specifies root directory of Apt executable.
 102 #
 103 # @param sources_list
 104 #   Specifies the path of the sources_list file to use.
 105 #
 106 # @param sources_list_d
 107 #   Specifies the path of the sources_list.d file to use.
 108 #
 109 # @param conf_d
 110 #   Specifies the path of the conf.d file to use.
 111 #
 112 # @param preferences
 113 #   Specifies the path of the preferences file to use.
 114 #
 115 # @param preferences_d
 116 #   Specifies the path of the preferences.d file to use.
 117 #
 118 # @param config_files
 119 #   A hash made up of the various configuration files used by Apt.
 120 #
 121 class apt (
 122   Hash $update_defaults         = $apt::params::update_defaults,
 123   Hash $purge_defaults          = $apt::params::purge_defaults,
 124   Hash $proxy_defaults          = $apt::params::proxy_defaults,
 125   Hash $include_defaults        = $apt::params::include_defaults,
 126   String $provider              = $apt::params::provider,
 127   String $keyserver             = $apt::params::keyserver,
 128   Optional[String] $key_options = $apt::params::key_options,
 129   Optional[String] $ppa_options = $apt::params::ppa_options,
 130   Optional[String] $ppa_package = $apt::params::ppa_package,
 131   Optional[Hash] $backports     = $apt::params::backports,
 132   Hash $confs                   = $apt::params::confs,
 133   Hash $update                  = $apt::params::update,
 134   Hash $purge                   = $apt::params::purge,
 135   Apt::Proxy $proxy             = $apt::params::proxy,
 136   Hash $sources                 = $apt::params::sources,
 137   Hash $keys                    = $apt::params::keys,
 138   Hash $ppas                    = $apt::params::ppas,
 139   Hash $pins                    = $apt::params::pins,
 140   Hash $settings                = $apt::params::settings,
 141   Boolean $manage_auth_conf     = $apt::params::manage_auth_conf,
 142   Array[Apt::Auth_conf_entry]
 143     $auth_conf_entries          = $apt::params::auth_conf_entries,
 144   String $auth_conf_owner       = $apt::params::auth_conf_owner,
 145   String $root                  = $apt::params::root,
 146   String $sources_list          = $apt::params::sources_list,
 147   String $sources_list_d        = $apt::params::sources_list_d,
 148   String $conf_d                = $apt::params::conf_d,
 149   String $preferences           = $apt::params::preferences,
 150   String $preferences_d         = $apt::params::preferences_d,
 151   String $apt_conf_d            = $apt::params::apt_conf_d,
 152   Hash $config_files            = $apt::params::config_files,
 153   Hash $source_key_defaults     = $apt::params::source_key_defaults,
 154 ) inherits apt::params {
 155
 156   if $facts['osfamily'] != 'Debian' {
 157     fail(translate('This module only works on Debian or derivatives like Ubuntu'))
 158   }
 159
 160   if $update['frequency'] {
 161     assert_type(
 162       Enum['always','daily','weekly','reluctantly'],
 163       $update['frequency'],
 164     )
 165   }
 166   if $update['timeout'] {
 167     assert_type(Integer, $update['timeout'])
 168   }
 169   if $update['tries'] {
 170     assert_type(Integer, $update['tries'])
 171   }
 172
 173   $_update = merge($::apt::update_defaults, $update)
 174   include ::apt::update
 175
 176   if $purge['sources.list'] {
 177     assert_type(Boolean, $purge['sources.list'])
 178   }
 179   if $purge['sources.list.d'] {
 180     assert_type(Boolean, $purge['sources.list.d'])
 181   }
 182   if $purge['preferences'] {
 183     assert_type(Boolean, $purge['preferences'])
 184   }
 185   if $purge['preferences.d'] {
 186     assert_type(Boolean, $purge['preferences.d'])
 187   }
 188   if $purge['apt.conf.d'] {
 189     assert_type(Boolean, $purge['apt.conf.d'])
 190   }
 191
 192   $_purge = merge($::apt::purge_defaults, $purge)
 193   $_proxy = merge($apt::proxy_defaults, $proxy)
 194
 195   $confheadertmp = epp('apt/_conf_header.epp')
 196   $proxytmp = epp('apt/proxy.epp', {'proxies' => $_proxy})
 197   $updatestamptmp = epp('apt/15update-stamp.epp')
 198
 199   if $_proxy['ensure'] == 'absent' or $_proxy['host'] {
 200     apt::setting { 'conf-proxy':
 201       ensure   => $_proxy['ensure'],
 202       priority => '01',
 203       content  => "${confheadertmp}${proxytmp}",
 204     }
 205   }
 206
 207   $sources_list_ensure = $_purge['sources.list'] ? {
 208     true    => absent,
 209     default => file,
 210   }
 211
 212   $preferences_ensure = $_purge['preferences'] ? {
 213     true    => absent,
 214     default => file,
 215   }
 216
 217   if $_update['frequency'] == 'always' {
 218     Exec <| title=='apt_update' |> {
 219       refreshonly => false,
 220     }
 221   }
 222
 223   apt::setting { 'conf-update-stamp':
 224     priority => 15,
 225     content  => "${confheadertmp}${updatestamptmp}",
 226   }
 227
 228   file { 'sources.list':
 229     ensure => $sources_list_ensure,
 230     path   => $::apt::sources_list,
 231     owner  => root,
 232     group  => root,
 233     notify => Class['apt::update'],
 234   }
 235
 236   file { 'sources.list.d':
 237     ensure  => directory,
 238     path    => $::apt::sources_list_d,
 239     owner   => root,
 240     group   => root,
 241     purge   => $_purge['sources.list.d'],
 242     recurse => $_purge['sources.list.d'],
 243     notify  => Class['apt::update'],
 244   }
 245
 246   file { 'preferences':
 247     ensure => $preferences_ensure,
 248     path   => $::apt::preferences,
 249     owner  => root,
 250     group  => root,
 251     notify => Class['apt::update'],
 252   }
 253
 254   file { 'preferences.d':
 255     ensure  => directory,
 256     path    => $::apt::preferences_d,
 257     owner   => root,
 258     group   => root,
 259     purge   => $_purge['preferences.d'],
 260     recurse => $_purge['preferences.d'],
 261     notify  => Class['apt::update'],
 262   }
 263
 264   file { 'apt.conf.d':
 265     ensure  => directory,
 266     path    => $::apt::apt_conf_d,
 267     owner   => root,
 268     group   => root,
 269     purge   => $_purge['apt.conf.d'],
 270     recurse => $_purge['apt.conf.d'],
 271     notify  => Class['apt::update'],
 272   }
 273
 274   if $confs {
 275     create_resources('apt::conf', $confs)
 276   }
 277   # manage sources if present
 278   if $sources {
 279     create_resources('apt::source', $sources)
 280   }
 281   # manage keys if present
 282   if $keys {
 283     create_resources('apt::key', $keys)
 284   }
 285   # manage ppas if present
 286   if $ppas {
 287     create_resources('apt::ppa', $ppas)
 288   }
 289   # manage settings if present
 290   if $settings {
 291     create_resources('apt::setting', $settings)
 292   }
 293
 294   if $manage_auth_conf {
 295     $auth_conf_ensure = $auth_conf_entries ? {
 296       []      => 'absent',
 297       default => 'present',
 298     }
 299
 300     $auth_conf_tmp = epp('apt/auth_conf.epp')
 301
 302     file { '/etc/apt/auth.conf':
 303       ensure  => $auth_conf_ensure,
 304       owner   => $auth_conf_owner,
 305       group   => 'root',
 306       mode    => '0600',
 307       content => "${confheadertmp}${auth_conf_tmp}",
 308       notify  => Class['apt::update'],
 309     }
 310   }
 311
 312   # manage pins if present
 313   if $pins {
 314     create_resources('apt::pin', $pins)
 315   }
 316
 317   # required for adding GPG keys on Debian 9 (and derivatives)
 318   ensure_packages(['gnupg'])
 319 }