1 # @summary Main class, includes all other classes.
3 # @see https://docs.puppetlabs.com/references/latest/function.html#createresources for the create resource function
6 # Specifies the provider that should be used by apt::update.
9 # Specifies a keyserver to provide the GPG key. Valid options: a string containing a domain name or a full URL (http://, https://, or
13 # Specifies the default options for apt::key resources.
16 # Supplies options to be passed to the `add-apt-repository` command.
19 # Names the package that provides the `apt-add-repository` command.
22 # Specifies some of the default parameters used by apt::backports. Valid options: a hash made up from the following keys:
24 # @option backports [String] :location
25 # See apt::backports for documentation.
27 # @option backports [String] :repos
28 # See apt::backports for documentation.
30 # @option backports [String] :key
31 # See apt::backports for documentation.
34 # Creates new `apt::conf` resources. Valid options: a hash to be passed to the create_resources function linked above.
37 # Configures various update settings. Valid options: a hash made up from the following keys:
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'.
45 # @option update [Integer] :loglevel
46 # Specifies the log level of logs outputted to the console. Default: undef.
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.
51 # @option update [Integer] :tries
52 # Specifies how many times to retry the update after receiving a DNS or HTTP error. Default: undef.
55 # Specifies whether to purge any existing settings that aren't managed by Puppet. Valid options: a hash made up from the following keys:
57 # @option purge [Boolean] :sources.list
58 # Specifies whether to purge any unmanaged entries from sources.list. Default false.
60 # @option purge [Boolean] :sources.list.d
61 # Specifies whether to purge any unmanaged entries from sources.list.d. Default false.
63 # @option purge [Boolean] :preferences
64 # Specifies whether to purge any unmanaged entries from preferences. Default false.
66 # @option purge [Boolean] :preferences.d.
67 # Specifies whether to purge any unmanaged entries from preferences.d. Default false.
70 # Configures Apt to connect to a proxy server. Valid options: a hash matching the locally defined type apt::proxy.
73 # Creates new `apt::source` resources. Valid options: a hash to be passed to the create_resources function linked above.
76 # Creates new `apt::key` resources. Valid options: a hash to be passed to the create_resources function linked above.
79 # Creates new `apt::ppa` resources. Valid options: a hash to be passed to the create_resources function linked above.
82 # Creates new `apt::pin` resources. Valid options: a hash to be passed to the create_resources function linked above.
85 # Creates new `apt::setting` resources. Valid options: a hash to be passed to the create_resources function linked above.
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.
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.
97 # @param auth_conf_owner
98 # The owner of the file /etc/apt/auth.conf. Default: '_apt' or 'root' on old releases.
101 # Specifies root directory of Apt executable.
103 # @param sources_list
104 # Specifies the path of the sources_list file to use.
106 # @param sources_list_d
107 # Specifies the path of the sources_list.d file to use.
110 # Specifies the path of the conf.d file to use.
113 # Specifies the path of the preferences file to use.
115 # @param preferences_d
116 # Specifies the path of the preferences.d file to use.
118 # @param config_files
119 # A hash made up of the various configuration files used by Apt.
121 # @param sources_list_force
122 # Specifies whether to perform force purge or delete. Default false.
125 Hash $update_defaults = $apt::params::update_defaults,
126 Hash $purge_defaults = $apt::params::purge_defaults,
127 Hash $proxy_defaults = $apt::params::proxy_defaults,
128 Hash $include_defaults = $apt::params::include_defaults,
129 String $provider = $apt::params::provider,
130 String $keyserver = $apt::params::keyserver,
131 Optional[String] $key_options = $apt::params::key_options,
132 Optional[String] $ppa_options = $apt::params::ppa_options,
133 Optional[String] $ppa_package = $apt::params::ppa_package,
134 Optional[Hash] $backports = $apt::params::backports,
135 Hash $confs = $apt::params::confs,
136 Hash $update = $apt::params::update,
137 Hash $purge = $apt::params::purge,
138 Apt::Proxy $proxy = $apt::params::proxy,
139 Hash $sources = $apt::params::sources,
140 Hash $keys = $apt::params::keys,
141 Hash $ppas = $apt::params::ppas,
142 Hash $pins = $apt::params::pins,
143 Hash $settings = $apt::params::settings,
144 Boolean $manage_auth_conf = $apt::params::manage_auth_conf,
145 Array[Apt::Auth_conf_entry]
146 $auth_conf_entries = $apt::params::auth_conf_entries,
147 String $auth_conf_owner = $apt::params::auth_conf_owner,
148 String $root = $apt::params::root,
149 String $sources_list = $apt::params::sources_list,
150 String $sources_list_d = $apt::params::sources_list_d,
151 String $conf_d = $apt::params::conf_d,
152 String $preferences = $apt::params::preferences,
153 String $preferences_d = $apt::params::preferences_d,
154 String $apt_conf_d = $apt::params::apt_conf_d,
155 Hash $config_files = $apt::params::config_files,
156 Boolean $sources_list_force = $apt::params::sources_list_force,
158 Hash $source_key_defaults = {
159 'server' => $keyserver,
165 ) inherits apt::params {
167 if $facts['os']['family'] != 'Debian' {
168 fail('This module only works on Debian or derivatives like Ubuntu')
171 if $update['frequency'] {
173 Enum['always','daily','weekly','reluctantly'],
174 $update['frequency'],
177 if $update['timeout'] {
178 assert_type(Integer, $update['timeout'])
180 if $update['tries'] {
181 assert_type(Integer, $update['tries'])
184 $_update = merge($::apt::update_defaults, $update)
185 include ::apt::update
187 if $purge['sources.list'] {
188 assert_type(Boolean, $purge['sources.list'])
190 if $purge['sources.list.d'] {
191 assert_type(Boolean, $purge['sources.list.d'])
193 if $purge['preferences'] {
194 assert_type(Boolean, $purge['preferences'])
196 if $purge['preferences.d'] {
197 assert_type(Boolean, $purge['preferences.d'])
199 if $sources_list_force {
200 assert_type(Boolean, $sources_list_force)
202 if $purge['apt.conf.d'] {
203 assert_type(Boolean, $purge['apt.conf.d'])
206 $_purge = merge($::apt::purge_defaults, $purge)
207 $_proxy = merge($apt::proxy_defaults, $proxy)
209 $confheadertmp = epp('apt/_conf_header.epp')
210 $proxytmp = epp('apt/proxy.epp', {'proxies' => $_proxy})
211 $updatestamptmp = epp('apt/15update-stamp.epp')
213 if $_proxy['ensure'] == 'absent' or $_proxy['host'] {
214 apt::setting { 'conf-proxy':
215 ensure => $_proxy['ensure'],
217 content => "${confheadertmp}${proxytmp}",
221 if $sources_list_force {
222 $sources_list_ensure = $_purge['sources.list'] ? {
226 $sources_list_content = $_purge['sources.list'] ? {
233 $sources_list_ensure = $_purge['sources.list'] ? {
237 $sources_list_content = $_purge['sources.list'] ? {
238 true => "# Repos managed by puppet.\n",
243 $preferences_ensure = $_purge['preferences'] ? {
248 if $_update['frequency'] == 'always' {
249 Exec <| title=='apt_update' |> {
250 refreshonly => false,
254 apt::setting { 'conf-update-stamp':
256 content => "${confheadertmp}${updatestamptmp}",
259 file { 'sources.list':
260 ensure => $sources_list_ensure,
261 path => $::apt::sources_list,
264 content => $sources_list_content,
265 notify => Class['apt::update'],
268 file { 'sources.list.d':
270 path => $::apt::sources_list_d,
273 purge => $_purge['sources.list.d'],
274 recurse => $_purge['sources.list.d'],
275 notify => Class['apt::update'],
278 file { 'preferences':
279 ensure => $preferences_ensure,
280 path => $::apt::preferences,
283 notify => Class['apt::update'],
286 file { 'preferences.d':
288 path => $::apt::preferences_d,
291 purge => $_purge['preferences.d'],
292 recurse => $_purge['preferences.d'],
293 notify => Class['apt::update'],
298 path => $::apt::apt_conf_d,
301 purge => $_purge['apt.conf.d'],
302 recurse => $_purge['apt.conf.d'],
303 notify => Class['apt::update'],
307 create_resources('apt::conf', $confs)
309 # manage sources if present
311 create_resources('apt::source', $sources)
313 # manage keys if present
315 create_resources('apt::key', $keys)
317 # manage ppas if present
319 create_resources('apt::ppa', $ppas)
321 # manage settings if present
323 create_resources('apt::setting', $settings)
326 if $manage_auth_conf {
327 $auth_conf_ensure = $auth_conf_entries ? {
329 default => 'present',
332 $auth_conf_tmp = epp('apt/auth_conf.epp')
334 file { '/etc/apt/auth.conf':
335 ensure => $auth_conf_ensure,
336 owner => $auth_conf_owner,
339 content => Sensitive("${confheadertmp}${auth_conf_tmp}"),
340 notify => Class['apt::update'],
344 # manage pins if present
346 create_resources('apt::pin', $pins)
349 # required for adding GPG keys on Debian 9 (and derivatives)
350 ensure_packages(['gnupg'])