Puppet Class: prometheus::alertmanager

Inherits:
prometheus
Defined in:
manifests/alertmanager.pp

Overview

Class: prometheus::alertmanager

This module manages prometheus alertmanager

Parameters:

[*arch*]
Architecture (amd64 or i386)

[*bin_dir*]
Directory where binaries are located

[*config_file*]
The path to put the configuration file

[*config_mode*]
The permissions of the configuration files

[*download_extension*]
Extension for the release binary archive

[*download_url*]
Complete URL corresponding to the where the release binary archive can be downloaded

[*download_url_base*]
Base URL for the binary archive

[*extra_groups*]
Extra groups to add the binary user to

[*extra_options*]
Extra options added to the startup command

[*global*]
The global alertmanager configuration.
Example (also default):

prometheus::alertmanager::global:
  smtp_smarthost: 'localhost:25'
  smtp_from: 'alertmanager@localhost'

[*group*]
Group under which the binary is running

[*inhibit_rules*]
An array of inhibit rules.
Example (also default):

prometheus::alertmanager::inhibit_rules:
- source_match:
    severity: 'critical'
    target_match:
      severity: 'warning'
    equal:
    - 'alertname'
    - 'cluster'
    - 'service'

[*init_style*]
Service startup scripts style (e.g. rc, upstart or systemd)

[*install_method*]
Installation method: url or package (only url is supported currently)

[*manage_group*]
Whether to create a group for or rely on external code for that

[*manage_service*]
Should puppet manage the service? (default true)

[*manage_user*]
Whether to create user or rely on external code for that

[*os*]
Operating system (linux is the only one supported)

[*package_ensure*]
If package, then use this for package ensure default 'latest'

[*package_name*]
The binary package name - not available yet

[*purge_config_dir*]
Purge config files no longer generated by Puppet

[*receivers*]
An array of receivers.
Example (also default):

prometheus::alertmanager::receivers:
- name: 'Admin'
  email_configs:
    - to: 'root@localhost'

[*restart_on_change*]
Should puppet restart the service on configuration change? (default true)

[*route*]
The top level route.
Example (also default):

prometheus::alertmanager::route:
  group_by:
    - 'alertname'
    - 'cluster'
    - 'service'
  group_wait: '30s'
  group_interval: '5m'
  repeat_interval: '3h'
  receiver: 'Admin'

[*service_enable*]
Whether to enable the service from puppet (default true)

[*service_ensure*]
State ensured for the service (default 'running')

[*service_name*]
Name of the alertmanager service (default 'alertmanager')

[*storage_path*]
The storage path to pass to the alertmanager. Defaults to '/var/lib/alertmanager'

[*templates*]
The array of template files. Defaults to [ "${config_dir}/*.tmpl" ]

[*user*]
User which runs the service

[*version*]
The binary release version

Parameters:

  • config_dir (Stdlib::Absolutepath)
  • config_file (Stdlib::Absolutepath)
  • download_extension (String)
  • download_url_base (Variant[Stdlib::HTTPUrl, Stdlib::HTTPSUrl])
  • extra_groups (Array)
  • global (Hash)
  • group (String)
  • inhibit_rules (Array)
  • package_ensure (String)
  • package_name (String)
  • receivers (Array)
  • route (Hash)
  • storage_path (Stdlib::Absolutepath)
  • templates (Array)
  • user (String)
  • version (String)
  • service_enable (Boolean) (defaults to: true)
  • service_ensure (String) (defaults to: 'running')
  • service_name (String) (defaults to: 'alertmanager')
  • restart_on_change (Boolean) (defaults to: true)
  • purge_config_dir (Boolean) (defaults to: true)
  • init_style (String) (defaults to: $prometheus::init_style)
  • install_method (String) (defaults to: $prometheus::install_method)
  • manage_group (Boolean) (defaults to: true)
  • manage_service (Boolean) (defaults to: true)
  • manage_user (Boolean) (defaults to: true)
  • os (String) (defaults to: $prometheus::os)
  • extra_options (String) (defaults to: '')
  • download_url (Optional[String]) (defaults to: undef)
  • config_mode (String) (defaults to: $prometheus::config_mode)
  • arch (String) (defaults to: $prometheus::real_arch)
  • bin_dir (Stdlib::Absolutepath) (defaults to: $prometheus::bin_dir) 


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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'manifests/alertmanager.pp', line 131

class prometheus::alertmanager (
  Stdlib::Absolutepath $config_dir,
  Stdlib::Absolutepath $config_file,
  String $download_extension,
  Variant[Stdlib::HTTPUrl, Stdlib::HTTPSUrl] $download_url_base,
  Array $extra_groups,
  Hash $global,
  String $group,
  Array $inhibit_rules,
  String $package_ensure,
  String $package_name,
  Array $receivers,
  Hash $route,
  Stdlib::Absolutepath $storage_path,
  Array $templates,
  String $user,
  String $version,
  Boolean $service_enable        = true,
  String $service_ensure         = 'running',
  String $service_name           = 'alertmanager',
  Boolean $restart_on_change     = true,
  Boolean $purge_config_dir      = true,
  String $init_style             = $prometheus::init_style,
  String $install_method         = $prometheus::install_method,
  Boolean $manage_group          = true,
  Boolean $manage_service        = true,
  Boolean $manage_user           = true,
  String $os                     = $prometheus::os,
  String $extra_options          = '',
  Optional[String] $download_url = undef,
  String $config_mode            = $prometheus::config_mode,
  String $arch                   = $prometheus::real_arch,
  Stdlib::Absolutepath $bin_dir  = $prometheus::bin_dir,
) inherits prometheus {

  if( versioncmp($version, '0.3.0') == -1 ){
    $real_download_url    = pick($download_url,
      "${download_url_base}/download/${version}/${package_name}-${version}.${os}-${arch}.${download_extension}")
  } else {
    $real_download_url    = pick($download_url,
      "${download_url_base}/download/v${version}/${package_name}-${version}.${os}-${arch}.${download_extension}")
  }
  $notify_service = $restart_on_change ? {
    true    => Service[$service_name],
    default => undef,
  }

  file { $config_dir:
    ensure  => 'directory',
    owner   => $user,
    group   => $group,
    purge   => $purge_config_dir,
    recurse => $purge_config_dir,
  }

  file { $config_file:
    ensure  => present,
    owner   => $user,
    group   => $group,
    mode    => $config_mode,
    content => template('prometheus/alertmanager.yaml.erb'),
    notify  => Service['alertmanager'],
    require => File[$config_dir],
  }

  if $facts['prometheus_alert_manager_running'] == 'running' {
    # This is here to stop the previous alertmanager that was installed in version 0.1.14
    service { 'alert_manager':
      ensure => 'stopped',
    }
  }

  if $storage_path {
    file { $storage_path:
      ensure => 'directory',
      owner  => $user,
      group  =>  $group,
      mode   => '0755',
    }

    if( versioncmp($version, '0.12.0') == 1 ){
      $options = "--config.file=${prometheus::alertmanager::config_file} --storage.path=${prometheus::alertmanager::storage_path} ${prometheus::alertmanager::extra_options}"
    } else {
      $options = "-config.file=${prometheus::alertmanager::config_file} -storage.path=${prometheus::alertmanager::storage_path} ${prometheus::alertmanager::extra_options}"
    }
  } else {
    if( versioncmp($prometheus::alertmanager::version, '0.12.0') == 1 ){
      $options = "--config.file=${prometheus::alertmanager::config_file} ${prometheus::alertmanager::extra_options}"
    } else {
      $options = "-config.file=${prometheus::alertmanager::config_file} ${prometheus::alertmanager::extra_options}"
    }
  }

  prometheus::daemon { $service_name:
    install_method     => $install_method,
    version            => $version,
    download_extension => $download_extension,
    os                 => $os,
    arch               => $arch,
    real_download_url  => $real_download_url,
    bin_dir            => $bin_dir,
    notify_service     => $notify_service,
    package_name       => $package_name,
    package_ensure     => $package_ensure,
    manage_user        => $manage_user,
    user               => $user,
    extra_groups       => $extra_groups,
    group              => $group,
    manage_group       => $manage_group,
    purge              => $purge_config_dir,
    options            => $options,
    init_style         => $init_style,
    service_ensure     => $service_ensure,
    service_enable     => $service_enable,
    manage_service     => $manage_service,
  }
}