Puppet Class: zabbix::server

Inherits:
zabbix::params
Defined in:
manifests/server.pp

Overview

Class: zabbix::server

This will install and configure the zabbix-server deamon

Requirements

Parameters

database_type

Type of database. Can use the following 2 databases:

  • postgresql

  • mysql

database_path

When database binaries are not found on the default path: /bin:/usr/bin:/usr/local/sbin:/usr/local/bin you can use this parameter to add the database_path to the above mentioned path.

zabbix_version

This is the zabbix version. Example: 2.4

manage_repo

When true (default) this module will manage the Zabbix repository

zabbix_package_state

The state of the package that needs to be installed: present or latest. Default: present

manage_firewall

When true, it will create iptables rules.

server_configfile_path

Server config file path defaults to /etc/zabbix/zabbix_server.conf

nodeid

Unique nodeid in distributed setup. (Deprecated since 2.4)

listenport

Listen port for the zabbix-server. Default: 10051

sourceip

Source ip address for outgoing connections.

logfile

Name of log file.

logfilesize

Maximum size of log file in MB.

debuglevel

Specifies debug level.

pidfile

Name of pid file.

database_host

Database host name.

database_name

Database name.

database_schema

Schema name. used for ibm db2.

database_user

Database user. ignored for sqlite.

database_password

Database password. ignored for sqlite.

database_socket

Path to mysql socket.

database_port

Database port when not using local socket. Ignored for sqlite.

startpollers

Number of pre-forked instances of pollers.

startipmipollers

Number of pre-forked instances of ipmi pollers.

startpollersunreachable

Number of pre-forked instances of pollers for unreachable hosts (including ipmi).

starttrappers

Number of pre-forked instances of trappers.

startpingers

Number of pre-forked instances of icmp pingers.

startdiscoverers

Number of pre-forked instances of discoverers.

starthttppollers

Number of pre-forked instances of http pollers.

starttimers

Number of pre-forked instances of timers.

javagateway

IP address (or hostname) of zabbix java gateway.

javagatewayport

Port that zabbix java gateway listens on.

startjavapollers

Number of pre-forked instances of java pollers.

startvmwarecollectors

Number of pre-forked vmware collector instances.

vmwarefrequency

How often zabbix will connect to vmware service to obtain a new datan.

vmwarecachesize

Size of vmware cache, in bytes.

snmptrapperfile

Temporary file used for passing data from snmp trap daemon to the server.

startsnmptrapper

If 1, snmp trapper process is started.

listenip

List of comma delimited ip addresses that the zabbix-server should listen on.

housekeepingfrequency

How often zabbix will perform housekeeping procedure (in hours).

maxhousekeeperdelete

the table “housekeeper” contains “tasks” for housekeeping procedure in the format: [housekeeperid], [tablename], [field], [value]. no more than ‘maxhousekeeperdelete’ rows (corresponding to [tablename], [field], [value]) will be deleted per one task in one housekeeping cycle. sqlite3 does not use this parameter, deletes all corresponding rows without a limit. if set to 0 then no limit is used at all. in this case you must know what you are doing!

senderfrequency

How often zabbix will try to send unsent alerts (in seconds).

cachesize

Size of configuration cache, in bytes.

cacheupdatefrequency

How often zabbix will perform update of configuration cache, in seconds.

startdbsyncers

Number of pre-forked instances of db syncers.

historycachesize

Size of history cache, in bytes.

trendcachesize

Size of trend cache, in bytes.

historytextcachesize

Size of text history cache, in bytes.

valuecachesize

Size of history value cache, in bytes.

nodenoevents

If set to ‘1’ local events won’t be sent to master node. (Deprecated since 2.4)

nodenohistory

If set to ‘1’ local history won’t be sent to master node. (Deprecated since 2.4)

timeout

Specifies how long we wait for agent, snmp device or external check (in seconds).

tlscafile

Full pathname of a file containing the top-level CA(s) certificates for peer certificate verification.

tlscertfile

Full pathname of a file containing the server certificate or certificate chain.

tlscrlfile

Full pathname of a file containing revoked certificates.

tlskeyfile

Full pathname of a file containing the server private key.

trappertimeout

Specifies how many seconds trapper may spend processing new data.

unreachableperiod

After how many seconds of unreachability treat a host as unavailable.

unavailabledelay

How often host is checked for availability during the unavailability period, in seconds.

unreachabledelay

How often host is checked for availability during the unreachability period, in seconds.

alertscriptspath

Full path to location of custom alert scripts.

externalscripts

Full path to location of external scripts.

fpinglocation

Location of fping.

fping6location

Location of fping6.

sshkeylocation

Location of public and private keys for ssh checks and actions.

logslowqueries

How long a database query may take before being logged (in milliseconds).

tmpdir

Temporary directory.

startproxypollers

Number of pre-forked instances of pollers for passive proxies.

proxyconfigfrequency

How often zabbix server sends configuration data to a zabbix proxy in seconds.

proxydatafrequency

How often zabbix server requests history data from a zabbix proxy in seconds.

allowroot

Allow the server to run as ‘root’.

include_dir

You may include individual files or all files in a directory in the configuration file.

loadmodulepath

Full path to location of server modules.

loadmodule

Module to load at server startup.

sslcertlocation_dir

Location of SSL client certificate files for client authentication.

sslkeylocation_dir

Location of SSL private key files for client authentication.

Example

When running everything on a single node, please check
documentation in init.pp
The following is an example of an multiple host setup:

node 'wdpuppet03.dj-wasabi.local' {
  #class { 'postgresql::client': }
  class { 'mysql::client': }
  class { 'zabbix::server':
    zabbix_version => '2.4',
    database_host  => 'wdpuppet04.dj-wasabi.local',
    database_type  => 'mysql',
  }
}

The setup of above shows an configuration which used mysql as database.
It will require the database "client" classes, this is needed for executing
the installation files.

When database_type = postgres, uncomment the postgresql::client class and change or
remove the database_type parameter and comment the mysql::client class.

Authors

Author Name: ikben@werner-dijkerman.nl

Copyright 2014 Werner Dijkerman

Parameters:

  • database_type (Any) (defaults to: $zabbix::params::database_type)
  • database_path (Any) (defaults to: $zabbix::params::database_path)
  • zabbix_version (Any) (defaults to: $zabbix::params::zabbix_version)
  • zabbix_package_state (Any) (defaults to: $zabbix::params::zabbix_package_state)
  • manage_firewall (Any) (defaults to: $zabbix::params::manage_firewall)
  • manage_repo (Any) (defaults to: $zabbix::params::manage_repo)
  • manage_database (Any) (defaults to: $zabbix::params::manage_database)
  • server_configfile_path (Any) (defaults to: $zabbix::params::server_configfile_path)
  • server_config_owner (Any) (defaults to: $zabbix::params::server_config_owner)
  • server_config_group (Any) (defaults to: $zabbix::params::server_config_group)
  • server_service_name (Any) (defaults to: $zabbix::params::server_service_name)
  • pacemaker (Any) (defaults to: $zabbix::params::server_pacemaker)
  • pacemaker_resource (Any) (defaults to: $zabbix::params::server_pacemaker_resource)
  • nodeid (Any) (defaults to: $zabbix::params::server_nodeid)
  • listenport (Any) (defaults to: $zabbix::params::server_listenport)
  • sourceip (Any) (defaults to: $zabbix::params::server_sourceip)
  • logfile (Any) (defaults to: $zabbix::params::server_logfile)
  • logfilesize (Any) (defaults to: $zabbix::params::server_logfilesize)
  • debuglevel (Any) (defaults to: $zabbix::params::server_debuglevel)
  • pidfile (Any) (defaults to: $zabbix::params::server_pidfile)
  • database_schema_path (Any) (defaults to: $zabbix::params::database_schema_path)
  • database_host (Any) (defaults to: $zabbix::params::server_database_host)
  • database_name (Any) (defaults to: $zabbix::params::server_database_name)
  • database_schema (Any) (defaults to: $zabbix::params::server_database_schema)
  • database_user (Any) (defaults to: $zabbix::params::server_database_user)
  • database_password (Any) (defaults to: $zabbix::params::server_database_password)
  • database_socket (Any) (defaults to: $zabbix::params::server_database_socket)
  • database_port (Any) (defaults to: $zabbix::params::server_database_port)
  • startpollers (Any) (defaults to: $zabbix::params::server_startpollers)
  • startipmipollers (Any) (defaults to: $zabbix::params::server_startipmipollers)
  • startpollersunreachable (Any) (defaults to: $zabbix::params::server_startpollersunreachable)
  • starttrappers (Any) (defaults to: $zabbix::params::server_starttrappers)
  • startpingers (Any) (defaults to: $zabbix::params::server_startpingers)
  • startdiscoverers (Any) (defaults to: $zabbix::params::server_startdiscoverers)
  • starthttppollers (Any) (defaults to: $zabbix::params::server_starthttppollers)
  • starttimers (Any) (defaults to: $zabbix::params::server_starttimers)
  • javagateway (Any) (defaults to: $zabbix::params::server_javagateway)
  • javagatewayport (Any) (defaults to: $zabbix::params::server_javagatewayport)
  • startjavapollers (Any) (defaults to: $zabbix::params::server_startjavapollers)
  • startvmwarecollectors (Any) (defaults to: $zabbix::params::server_startvmwarecollectors)
  • vmwarefrequency (Any) (defaults to: $zabbix::params::server_vmwarefrequency)
  • vmwarecachesize (Any) (defaults to: $zabbix::params::server_vmwarecachesize)
  • snmptrapperfile (Any) (defaults to: $zabbix::params::server_snmptrapperfile)
  • startsnmptrapper (Any) (defaults to: $zabbix::params::server_startsnmptrapper)
  • listenip (Any) (defaults to: $zabbix::params::server_listenip)
  • housekeepingfrequency (Any) (defaults to: $zabbix::params::server_housekeepingfrequency)
  • maxhousekeeperdelete (Any) (defaults to: $zabbix::params::server_maxhousekeeperdelete)
  • senderfrequency (Any) (defaults to: $zabbix::params::server_senderfrequency)
  • cachesize (Any) (defaults to: $zabbix::params::server_cachesize)
  • cacheupdatefrequency (Any) (defaults to: $zabbix::params::server_cacheupdatefrequency)
  • startdbsyncers (Any) (defaults to: $zabbix::params::server_startdbsyncers)
  • historycachesize (Any) (defaults to: $zabbix::params::server_historycachesize)
  • trendcachesize (Any) (defaults to: $zabbix::params::server_trendcachesize)
  • historytextcachesize (Any) (defaults to: $zabbix::params::server_historytextcachesize)
  • valuecachesize (Any) (defaults to: $zabbix::params::server_valuecachesize)
  • nodenoevents (Any) (defaults to: $zabbix::params::server_nodenoevents)
  • nodenohistory (Any) (defaults to: $zabbix::params::server_nodenohistory)
  • timeout (Any) (defaults to: $zabbix::params::server_timeout)
  • tlscafile (Any) (defaults to: $zabbix::params::server_tlscafile)
  • tlscertfile (Any) (defaults to: $zabbix::params::server_tlscertfile)
  • tlscrlfile (Any) (defaults to: $zabbix::params::server_tlscrlfile)
  • tlskeyfile (Any) (defaults to: $zabbix::params::server_tlskeyfile)
  • trappertimeout (Any) (defaults to: $zabbix::params::server_trappertimeout)
  • unreachableperiod (Any) (defaults to: $zabbix::params::server_unreachableperiod)
  • unavailabledelay (Any) (defaults to: $zabbix::params::server_unavailabledelay)
  • unreachabledelay (Any) (defaults to: $zabbix::params::server_unreachabledelay)
  • alertscriptspath (Any) (defaults to: $zabbix::params::server_alertscriptspath)
  • externalscripts (Any) (defaults to: $zabbix::params::server_externalscripts)
  • fpinglocation (Any) (defaults to: $zabbix::params::server_fpinglocation)
  • fping6location (Any) (defaults to: $zabbix::params::server_fping6location)
  • sshkeylocation (Any) (defaults to: $zabbix::params::server_sshkeylocation)
  • logslowqueries (Any) (defaults to: $zabbix::params::server_logslowqueries)
  • tmpdir (Any) (defaults to: $zabbix::params::server_tmpdir)
  • startproxypollers (Any) (defaults to: $zabbix::params::server_startproxypollers)
  • proxyconfigfrequency (Any) (defaults to: $zabbix::params::server_proxyconfigfrequency)
  • proxydatafrequency (Any) (defaults to: $zabbix::params::server_proxydatafrequency)
  • allowroot (Any) (defaults to: $zabbix::params::server_allowroot)
  • include_dir (Any) (defaults to: $zabbix::params::server_include)
  • loadmodulepath (Any) (defaults to: $zabbix::params::server_loadmodulepath)
  • loadmodule (Any) (defaults to: $zabbix::params::server_loadmodule)
  • sslcertlocation_dir (Any) (defaults to: $zabbix::params::server_sslcertlocation)
  • sslkeylocation_dir (Any) (defaults to: $zabbix::params::server_sslkeylocation)


281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
# File 'manifests/server.pp', line 281

class zabbix::server (
  $database_type           = $zabbix::params::database_type,
  $database_path           = $zabbix::params::database_path,
  $zabbix_version          = $zabbix::params::zabbix_version,
  $zabbix_package_state    = $zabbix::params::zabbix_package_state,
  $manage_firewall         = $zabbix::params::manage_firewall,
  $manage_repo             = $zabbix::params::manage_repo,
  $manage_database         = $zabbix::params::manage_database,
  $server_configfile_path  = $zabbix::params::server_configfile_path,
  $server_config_owner     = $zabbix::params::server_config_owner,
  $server_config_group     = $zabbix::params::server_config_group,
  $server_service_name     = $zabbix::params::server_service_name,
  $pacemaker               = $zabbix::params::server_pacemaker,
  $pacemaker_resource      = $zabbix::params::server_pacemaker_resource,
  $nodeid                  = $zabbix::params::server_nodeid,
  $listenport              = $zabbix::params::server_listenport,
  $sourceip                = $zabbix::params::server_sourceip,
  $logfile                 = $zabbix::params::server_logfile,
  $logfilesize             = $zabbix::params::server_logfilesize,
  $debuglevel              = $zabbix::params::server_debuglevel,
  $pidfile                 = $zabbix::params::server_pidfile,
  $database_schema_path    = $zabbix::params::database_schema_path,
  $database_host           = $zabbix::params::server_database_host,
  $database_name           = $zabbix::params::server_database_name,
  $database_schema         = $zabbix::params::server_database_schema,
  $database_user           = $zabbix::params::server_database_user,
  $database_password       = $zabbix::params::server_database_password,
  $database_socket         = $zabbix::params::server_database_socket,
  $database_port           = $zabbix::params::server_database_port,
  $startpollers            = $zabbix::params::server_startpollers,
  $startipmipollers        = $zabbix::params::server_startipmipollers,
  $startpollersunreachable = $zabbix::params::server_startpollersunreachable,
  $starttrappers           = $zabbix::params::server_starttrappers,
  $startpingers            = $zabbix::params::server_startpingers,
  $startdiscoverers        = $zabbix::params::server_startdiscoverers,
  $starthttppollers        = $zabbix::params::server_starthttppollers,
  $starttimers             = $zabbix::params::server_starttimers,
  $javagateway             = $zabbix::params::server_javagateway,
  $javagatewayport         = $zabbix::params::server_javagatewayport,
  $startjavapollers        = $zabbix::params::server_startjavapollers,
  $startvmwarecollectors   = $zabbix::params::server_startvmwarecollectors,
  $vmwarefrequency         = $zabbix::params::server_vmwarefrequency,
  $vmwarecachesize         = $zabbix::params::server_vmwarecachesize,
  $snmptrapperfile         = $zabbix::params::server_snmptrapperfile,
  $startsnmptrapper        = $zabbix::params::server_startsnmptrapper,
  $listenip                = $zabbix::params::server_listenip,
  $housekeepingfrequency   = $zabbix::params::server_housekeepingfrequency,
  $maxhousekeeperdelete    = $zabbix::params::server_maxhousekeeperdelete,
  $senderfrequency         = $zabbix::params::server_senderfrequency,
  $cachesize               = $zabbix::params::server_cachesize,
  $cacheupdatefrequency    = $zabbix::params::server_cacheupdatefrequency,
  $startdbsyncers          = $zabbix::params::server_startdbsyncers,
  $historycachesize        = $zabbix::params::server_historycachesize,
  $trendcachesize          = $zabbix::params::server_trendcachesize,
  $historytextcachesize    = $zabbix::params::server_historytextcachesize,
  $valuecachesize          = $zabbix::params::server_valuecachesize,
  $nodenoevents            = $zabbix::params::server_nodenoevents,
  $nodenohistory           = $zabbix::params::server_nodenohistory,
  $timeout                 = $zabbix::params::server_timeout,
  $tlscafile               = $zabbix::params::server_tlscafile,
  $tlscertfile             = $zabbix::params::server_tlscertfile,
  $tlscrlfile              = $zabbix::params::server_tlscrlfile,
  $tlskeyfile              = $zabbix::params::server_tlskeyfile,
  $trappertimeout          = $zabbix::params::server_trappertimeout,
  $unreachableperiod       = $zabbix::params::server_unreachableperiod,
  $unavailabledelay        = $zabbix::params::server_unavailabledelay,
  $unreachabledelay        = $zabbix::params::server_unreachabledelay,
  $alertscriptspath        = $zabbix::params::server_alertscriptspath,
  $externalscripts         = $zabbix::params::server_externalscripts,
  $fpinglocation           = $zabbix::params::server_fpinglocation,
  $fping6location          = $zabbix::params::server_fping6location,
  $sshkeylocation          = $zabbix::params::server_sshkeylocation,
  $logslowqueries          = $zabbix::params::server_logslowqueries,
  $tmpdir                  = $zabbix::params::server_tmpdir,
  $startproxypollers       = $zabbix::params::server_startproxypollers,
  $proxyconfigfrequency    = $zabbix::params::server_proxyconfigfrequency,
  $proxydatafrequency      = $zabbix::params::server_proxydatafrequency,
  $allowroot               = $zabbix::params::server_allowroot,
  $include_dir             = $zabbix::params::server_include,
  $loadmodulepath          = $zabbix::params::server_loadmodulepath,
  $loadmodule              = $zabbix::params::server_loadmodule,
  $sslcertlocation_dir     = $zabbix::params::server_sslcertlocation,
  $sslkeylocation_dir      = $zabbix::params::server_sslkeylocation,) inherits zabbix::params {
  # Only include the repo class if it has not yet been included
  unless defined(Class['Zabbix::Repo']) {
    class { '::zabbix::repo':
      zabbix_version => $zabbix_version,
      manage_repo    => $manage_repo,
    }
  }

  # Check some if they are boolean
  validate_bool($manage_firewall)

  # Get the correct database_type. We need this for installing the
  # correct package and loading the sql files.

  case $database_type {
    'postgresql' : {
      $db = 'pgsql'

      if $manage_database == true {
        # Execute the postgresql scripts
        class { '::zabbix::database::postgresql':
          zabbix_type          => 'server',
          zabbix_version       => $zabbix_version,
          database_schema_path => $database_schema_path,
          database_name        => $database_name,
          database_user        => $database_user,
          database_password    => $database_password,
          database_host        => $database_host,
          database_path        => $database_path,
          require              => Package["zabbix-server-${db}"],
        }
      }
    }
    'mysql'      : {
      $db = 'mysql'

      if $manage_database == true {
        # Execute the mysql scripts
        class { '::zabbix::database::mysql':
          zabbix_type          => 'server',
          zabbix_version       => $zabbix_version,
          database_schema_path => $database_schema_path,
          database_name        => $database_name,
          database_user        => $database_user,
          database_password    => $database_password,
          database_host        => $database_host,
          database_path        => $database_path,
          require              => Package["zabbix-server-${db}"],
        }
      }
    }
    default      : {
      fail('unrecognized database type for server.')
    }
  }

  # Installing the packages
  package { "zabbix-server-${db}":
    ensure  => $zabbix_package_state,
    require => Class['zabbix::repo'],
  }

  # Workaround for: The redhat provider can not handle attribute enable
  # This is only happening when using an redhat family version 5.x.
  if $::osfamily == 'redhat' and $::operatingsystemrelease !~ /^5.*/ {
    Service[$server_service_name] {
      enable => true }
  }

  # Controlling the 'zabbix-server' service
  if $pacemaker {
    exec { 'prevent zabbix boot-start':
      path    => '/usr/bin:/usr/sbin:/bin',
      command => "systemctl disable ${server_service_name}",
      onlyif  => "systemctl is-enabled ${server_service_name} | grep enabled >> /dev/null",
    }

    exec { 'stop zabbix if running without pacemaker':
      path    => '/usr/bin:/usr/sbin:/bin',
      command => "systemctl stop ${server_service_name}",
      onlyif  => "systemctl status ${server_service_name} | grep running >> /dev/null",
      unless  => "systemctl status ${server_service_name} | grep pacemaker >> /dev/null",
    }

    service { $server_service_name:
      ensure     => running,
      provider   => 'base',
      hasstatus  => true,
      hasrestart => true,
      status     => "/usr/sbin/pcs status resources | grep ${pacemaker_resource} | grep Started; echo $?",
      restart    => "/usr/sbin/pcs resource restart ${pacemaker_resource}",
      start      => "/usr/sbin/pcs resource start ${pacemaker_resource}",
      stop       => "/usr/sbin/pcs resource stop ${pacemaker_resource}",
      require    => [
        Package["zabbix-server-${db}"],
        File[$include_dir],
        File[$server_configfile_path],
        ],
    }
  } else {
    service { $server_service_name:
      ensure     => running,
      hasstatus  => true,
      hasrestart => true,
      require    => [
        Package["zabbix-server-${db}"],
        File[$include_dir],
        File[$server_configfile_path],
        ],
    }
  }

  # Configuring the zabbix-server configuration file
  file { $server_configfile_path:
    ensure  => present,
    owner   => $server_config_owner,
    group   => $server_config_group,
    mode    => '0640',
    notify  => Service[$server_service_name],
    require => Package["zabbix-server-${db}"],
    replace => true,
    content => template('zabbix/zabbix_server.conf.erb'),
  }

  # Include dir for specific zabbix-server checks.
  file { $include_dir:
    ensure  => directory,
    owner   => $server_config_owner,
    group   => $server_config_group,
    require => File[$server_configfile_path],
  }

  # Manage firewall
  if $manage_firewall {
    firewall { '151 zabbix-server':
      dport  => $listenport,
      proto  => 'tcp',
      action => 'accept',
      state  => [
        'NEW',
        'RELATED',
        'ESTABLISHED'],
    }
  }

  # check if selinux is active and allow zabbix
  if $::selinux_config_mode == 'enforcing' {
    selboolean{'zabbix_can_network':
      persistent => true,
      value      => 'on',
    }
  }
}