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