Puppet Class: apt

Defined in:
manifests/init.pp

Overview

Class: apt

This module manages the initial configuration of apt.

The parameters listed here are not required in general and were added for use cases related to development environments.

Parameters

disable_keys

Disables the requirement for all packages to be signed

always_apt_update

Rather apt should be updated on every run (intended for development environments where package updates are frequent)

apt_update_frequency

String: Supported values: always: Will fire ‘apt-get update` at every puppet run. Intended to

deprecate the `always_apt_update` parameter.

daily*: Trigger ‘apt-get update` if the value of the fact

`apt_update_last_success` is less than current epoch time - 86400.
 *notifying the apt_update exec will trigger apt-get update regardless*

weekly*: Trigger ‘apt-get update` if the value of the fact

`apt_update_last_success` is less than current epoch time - 604800.
 *notifying the apt_update exec will trigger apt-get update regardless*

reluctantly*: Default only run apt-get update if the exec resource ‘apt_update` is notified.

purge_sources_list

Accepts true or false. Defaults to false If set to true, Puppet will purge all unmanaged entries from sources.list

purge_sources_list_d

Accepts true or false. Defaults to false. If set to true, Puppet will purge all unmanaged entries from sources.list.d

update_timeout

Overrides the exec timeout in seconds for apt-get update. If not set defaults to Exec’s default (300)

update_tries

Number of times that ‘apt-get update` will be tried. Use this to work around transient DNS and HTTP errors. By default, the command will only be run once.

Examples

class { ‘apt’: }

Requires

puppetlabs/stdlib >= 2.2.1

Parameters:

  • always_apt_update (Any) (defaults to: false)
  • apt_update_frequency (Any) (defaults to: 'reluctantly')
  • disable_keys (Any) (defaults to: undef)
  • proxy_host (Any) (defaults to: undef)
  • proxy_port (Any) (defaults to: '8080')
  • purge_sources_list (Any) (defaults to: false)
  • purge_sources_list_d (Any) (defaults to: false)
  • purge_preferences (Any) (defaults to: false)
  • purge_preferences_d (Any) (defaults to: false)
  • update_timeout (Any) (defaults to: undef)
  • update_tries (Any) (defaults to: undef)
  • sources (Any) (defaults to: undef)
  • fancy_progress (Any) (defaults to: undef) 


54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'manifests/init.pp', line 54

class apt(
  $always_apt_update    = false,
  $apt_update_frequency = 'reluctantly',
  $disable_keys         = undef,
  $proxy_host           = undef,
  $proxy_port           = '8080',
  $purge_sources_list   = false,
  $purge_sources_list_d = false,
  $purge_preferences    = false,
  $purge_preferences_d  = false,
  $update_timeout       = undef,
  $update_tries         = undef,
  $sources              = undef,
  $fancy_progress       = undef
) {

  if $::osfamily != 'Debian' {
    fail('This module only works on Debian or derivatives like Ubuntu')
  }

  $frequency_options = ['always','daily','weekly','reluctantly']
  validate_re($apt_update_frequency, $frequency_options)
  include apt::params
  include apt::update

  validate_bool($purge_sources_list, $purge_sources_list_d,
                $purge_preferences, $purge_preferences_d)

  $sources_list_content = $purge_sources_list ? {
    false => undef,
    true  => "# Repos managed by puppet.\n",
  }

  if $always_apt_update == true {
    Exec <| title=='apt_update' |> {
      refreshonly => false,
    }
  }

  file { '/etc/apt/apt.conf.d/15update-stamp':
    ensure  => 'file',
    content => template('apt/_header.erb', 'apt/15update-stamp.erb'),
    group   => 'root',
    mode    => '0644',
    owner   => 'root',
  }

  $root           = $apt::params::root
  $apt_conf_d     = $apt::params::apt_conf_d
  $sources_list_d = $apt::params::sources_list_d
  $preferences_d  = $apt::params::preferences_d
  $provider       = $apt::params::provider

  file { 'sources.list':
    ensure  => present,
    path    => "${root}/sources.list",
    owner   => root,
    group   => root,
    mode    => '0644',
    content => $sources_list_content,
    notify  => Exec['apt_update'],
  }

  file { 'sources.list.d':
    ensure  => directory,
    path    => $sources_list_d,
    owner   => root,
    group   => root,
    purge   => $purge_sources_list_d,
    recurse => $purge_sources_list_d,
    notify  => Exec['apt_update'],
  }

  if $purge_preferences {
    file { 'apt-preferences':
      ensure => absent,
      path   => "${root}/preferences",
    }
  }

  file { 'preferences.d':
    ensure  => directory,
    path    => $preferences_d,
    owner   => root,
    group   => root,
    purge   => $purge_preferences_d,
    recurse => $purge_preferences_d,
  }

  case $fancy_progress {
    true: {
      file { '99progressbar':
        ensure  => present,
        content => template('apt/_header.erb', 'apt/progressbar.erb'),
        path    => "${apt_conf_d}/99progressbar",
      }
    }
    false: {
      file { '99progressbar':
        ensure => absent,
        path   => "${apt_conf_d}/99progressbar",
      }
    }
    undef: {} # do nothing
    default: { fail('Valid values for fancy_progress are true or false') }
  }

  case $disable_keys {
    true: {
      file { '99unauth':
        ensure  => present,
        content => template('apt/_header.erb', 'apt/unauth.erb'),
        path    => "${apt_conf_d}/99unauth",
      }
    }
    false: {
      file { '99unauth':
        ensure => absent,
        path   => "${apt_conf_d}/99unauth",
      }
    }
    undef:   { } # do nothing
    default: { fail('Valid values for disable_keys are true or false') }
  }

  case $proxy_host {
    false, '', undef: {
      file { '01proxy':
        ensure => absent,
        path   => "${apt_conf_d}/01proxy",
        notify => Exec['apt_update'],
      }
    }
    default: {
      file { '01proxy':
        ensure  => present,
        path    => "${apt_conf_d}/01proxy",
        content => template('apt/_header.erb', 'apt/proxy.erb'),
        notify  => Exec['apt_update'],
        mode    => '0644',
        owner   => root,
        group   => root,
      }
    }
  }

  file { 'old-proxy-file':
    ensure => absent,
    path   => "${apt_conf_d}/proxy",
    notify => Exec['apt_update'],
  }

  # Need anchor to provide containment for dependencies.
  anchor { 'apt::update':
    require => Class['apt::update'],
  }

  # manage sources if present
  if $sources != undef {
    validate_hash($sources)
    create_resources('apt::source', $sources)
  }
}