Puppet Class: zabbix::web

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

Overview

Class: zabbix::web

This will install the zabbix-web package and install an virtual host.

Requirements

The following is needed (or):
 - puppetlabs-apache

Parameters

zabbix_url

Url on which zabbix needs to be available. Will create an vhost in apache. Only needed when manage_vhost is set to true. Example: zabbix.example.com

database_type

Type of database. Can use the following 2 databases:

  • postgresql

  • mysql

manage_repo

When true, it will create repository for installing the webinterface.

zabbix_version

This is the zabbix version. Example: 2.4

zabbix_timezone

The current timezone for vhost configuration needed for the php timezone. Example: Europe/Amsterdam

zabbix_template_dir

The directory where all templates are stored before uploading via API

zabbix_package_state

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

manage_vhost

When true, it will create an vhost for apache. The parameter zabbix_url has to be set.

default_vhost

When true priority of 15 is passed to zabbix vhost which would end up with marking zabbix vhost as default one, when false priority is set to 25

manage_resources

When true, it will export resources to something like puppetdb. When set to true, you’ll need to configure ‘storeconfigs’ to make this happen. Default is set to false, as not everyone has this enabled.

apache_use_ssl

Will create an ssl vhost. Also nonssl vhost will be created for redirect nonssl to ssl vhost.

apache_ssl_cert

The location of the ssl certificate file. You’ll need to make sure this file is present on the system, this module will not install this file.

apache_ssl_key

The location of the ssl key file. You’ll need to make sure this file is present on the system, this module will not install this file.

apache_ssl_cipher

The ssl cipher used. Cipher is used from this website: wiki.mozilla.org/Security/Server_Side_TLS

[apache_ssl_chain}

The ssl chain file.

[apache_listenport}

The port for the apache vhost.

[apache_listenport_ssl}

The port for the apache SSL vhost.
zabbix_api_user

Name of the user which the api should connect to. Default: Admin

zabbix_api_pass

Password of the user which connects to the api. Default: zabbix

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.

zabbix_server

The fqdn name of the host running the zabbix-server. When single node: localhost

zabbix_listenport

The port on which the zabbix-server is listening. Default: 10051

apache_php_max_execution_time

Max execution time for php. Default: 300

apache_php_memory_limit

PHP memory size limit. Default: 128M

apache_php_post_max_size

PHP maximum post size data. Default: 16M

apache_php_upload_max_filesize

PHP maximum upload filesize. Default: 2M

apache_php_max_input_time

Max input time for php. Default: 300

apache_php_always_populate_raw_post_data

Default: -1

apache_php_max_input_vars

Max amount of vars for GET/POST requests

ldap_cacert

Set location of ca_cert used by LDAP authentication.

ldap_clientcrt

Set location of client cert used by LDAP authentication.

ldap_clientkey

Set location of client key used by LDAP authentication.

puppetgem

Provider for the zabbixapi gem package

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 'wdpuppet02.dj-wasabi.local' {
  class { 'apache':
      mpm_module => 'prefork',
  }
  class { 'apache::mod::php': }
  class { 'zabbix::web':
    zabbix_url    => 'zabbix.dj-wasabi.nl',
    zabbix_server => 'wdpuppet03.dj-wasabi.local',
    database_host => 'wdpuppet04.dj-wasabi.local',
    database_type => 'mysql',
    puppetgem     => 'gem',
  }
}

Authors

Author Name: ikben@werner-dijkerman.nl

Copyright 2016 Werner Dijkerman

Parameters:

  • zabbix_url (Any) (defaults to: $zabbix::params::zabbix_url)
  • database_type (Any) (defaults to: $zabbix::params::database_type)
  • manage_repo (Any) (defaults to: $zabbix::params::manage_repo)
  • zabbix_version (Any) (defaults to: $zabbix::params::zabbix_version)
  • zabbix_timezone (Any) (defaults to: $zabbix::params::zabbix_timezone)
  • zabbix_package_state (Any) (defaults to: $zabbix::params::zabbix_package_state)
  • zabbix_template_dir (Any) (defaults to: $zabbix::params::zabbix_template_dir)
  • manage_vhost (Any) (defaults to: $zabbix::params::manage_vhost)
  • default_vhost (Any) (defaults to: $zabbix::params::default_vhost)
  • manage_resources (Any) (defaults to: $zabbix::params::manage_resources)
  • apache_use_ssl (Any) (defaults to: $zabbix::params::apache_use_ssl)
  • apache_ssl_cert (Any) (defaults to: $zabbix::params::apache_ssl_cert)
  • apache_ssl_key (Any) (defaults to: $zabbix::params::apache_ssl_key)
  • apache_ssl_cipher (Any) (defaults to: $zabbix::params::apache_ssl_cipher)
  • apache_ssl_chain (Any) (defaults to: $zabbix::params::apache_ssl_chain)
  • apache_listen_ip (Any) (defaults to: $zabbix::params::apache_listen_ip)
  • apache_listenport (Any) (defaults to: $zabbix::params::apache_listenport)
  • apache_listenport_ssl (Any) (defaults to: $zabbix::params::apache_listenport_ssl)
  • zabbix_api_user (Any) (defaults to: $zabbix::params::server_api_user)
  • zabbix_api_pass (Any) (defaults to: $zabbix::params::server_api_pass)
  • 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)
  • zabbix_server (Any) (defaults to: $zabbix::params::zabbix_server)
  • zabbix_listenport (Any) (defaults to: $zabbix::params::server_listenport)
  • apache_php_max_execution_time (Any) (defaults to: $zabbix::params::apache_php_max_execution_time)
  • apache_php_memory_limit (Any) (defaults to: $zabbix::params::apache_php_memory_limit)
  • apache_php_post_max_size (Any) (defaults to: $zabbix::params::apache_php_post_max_size)
  • apache_php_upload_max_filesize (Any) (defaults to: $zabbix::params::apache_php_upload_max_filesize)
  • apache_php_max_input_time (Any) (defaults to: $zabbix::params::apache_php_max_input_time)
  • apache_php_always_populate_raw_post_data (Any) (defaults to: $zabbix::params::apache_php_always_populate_raw_post_data)
  • apache_php_max_input_vars (Any) (defaults to: $zabbix::params::apache_php_max_input_vars)
  • ldap_cacert (Any) (defaults to: $zabbix::params::ldap_cacert)
  • ldap_clientcert (Any) (defaults to: $zabbix::params::ldap_clientcert)
  • ldap_clientkey (Any) (defaults to: $zabbix::params::ldap_clientkey)
  • puppetgem (Any) (defaults to: $zabbix::params::puppetgem)


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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
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
# File 'manifests/web.pp', line 174

class zabbix::web (
  $zabbix_url                               = $zabbix::params::zabbix_url,
  $database_type                            = $zabbix::params::database_type,
  $manage_repo                              = $zabbix::params::manage_repo,
  $zabbix_version                           = $zabbix::params::zabbix_version,
  $zabbix_timezone                          = $zabbix::params::zabbix_timezone,
  $zabbix_package_state                     = $zabbix::params::zabbix_package_state,
  $zabbix_template_dir                      = $zabbix::params::zabbix_template_dir,
  $manage_vhost                             = $zabbix::params::manage_vhost,
  $default_vhost                            = $zabbix::params::default_vhost,
  $manage_resources                         = $zabbix::params::manage_resources,
  $apache_use_ssl                           = $zabbix::params::apache_use_ssl,
  $apache_ssl_cert                          = $zabbix::params::apache_ssl_cert,
  $apache_ssl_key                           = $zabbix::params::apache_ssl_key,
  $apache_ssl_cipher                        = $zabbix::params::apache_ssl_cipher,
  $apache_ssl_chain                         = $zabbix::params::apache_ssl_chain,
  $apache_listen_ip                         = $zabbix::params::apache_listen_ip,
  $apache_listenport                        = $zabbix::params::apache_listenport,
  $apache_listenport_ssl                    = $zabbix::params::apache_listenport_ssl,
  $zabbix_api_user                          = $zabbix::params::server_api_user,
  $zabbix_api_pass                          = $zabbix::params::server_api_pass,
  $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,
  $zabbix_server                            = $zabbix::params::zabbix_server,
  $zabbix_listenport                        = $zabbix::params::server_listenport,
  $apache_php_max_execution_time            = $zabbix::params::apache_php_max_execution_time,
  $apache_php_memory_limit                  = $zabbix::params::apache_php_memory_limit,
  $apache_php_post_max_size                 = $zabbix::params::apache_php_post_max_size,
  $apache_php_upload_max_filesize           = $zabbix::params::apache_php_upload_max_filesize,
  $apache_php_max_input_time                = $zabbix::params::apache_php_max_input_time,
  $apache_php_always_populate_raw_post_data = $zabbix::params::apache_php_always_populate_raw_post_data,
  $apache_php_max_input_vars                = $zabbix::params::apache_php_max_input_vars,
  $ldap_cacert                              = $zabbix::params::ldap_cacert,
  $ldap_clientcert                          = $zabbix::params::ldap_clientcert,
  $ldap_clientkey                           = $zabbix::params::ldap_clientkey,
  $puppetgem                                = $zabbix::params::puppetgem,
) inherits zabbix::params {
  $apache_user = getvar('::apache::user')
  $apache_group = getvar('::apache::group')

  # Only include the repo class if it has not yet been included
  unless defined(Class['Zabbix::Repo']) {
    class { '::zabbix::repo':
      manage_repo    => $manage_repo,
      zabbix_version => $zabbix_version,
    }
  }

  # use the correct db.
  case $database_type {
    'postgresql': {
      $db = 'pgsql'
      $db_port = '5432'
    }
    'mysql': {
      $db = 'mysql'
      $db_port = '3306'
    }
    default: {
      fail('unrecognized database type for server.')
    }
  }

  # So if manage_resources is set to true, we can send some data
  # to the puppetdb. We will include an class, otherwise when it
  # is set to false, you'll get warnings like this:
  # "Warning: You cannot collect without storeconfigs being set"
  if $manage_resources {
    include ::ruby::dev

    # Determine correct zabbixapi version.
    case $zabbix_version {
      '2.2' : {
        $zabbixapi_version = '2.2.2'
      }
      '2.4' : {
        $zabbixapi_version = '2.4.4'
      }
      default : {
        $zabbixapi_version = '2.4.7'
      }
    }

    # Installing the zabbixapi gem package. We need this gem for
    # communicating with the zabbix-api. This is way better then
    # doing it ourself.
    file { $zabbix_template_dir:
      ensure => directory,
      owner  => 'zabbix',
      group  => 'zabbix',
      mode   => '0755',
    } ->
    package { 'zabbixapi':
      ensure   => $zabbixapi_version,
      provider => $puppetgem,
      require  => Class['ruby::dev'],
    } ->
    class { '::zabbix::resources::web':
      zabbix_url     => $zabbix_url,
      zabbix_user    => $zabbix_api_user,
      zabbix_pass    => $zabbix_api_pass,
      apache_use_ssl => $apache_use_ssl,
    }
  }

  case $::operatingsystem {
    'ubuntu', 'debian' : {
      case $::operatingsystemmajrelease {
        '8' : {
          $zabbix_web_package = 'zabbix-frontend-php'
        }
        default : {
          $zabbix_web_package = 'zabbix-frontend-php'
        }
      }
      package { "php5-${db}":
        ensure => $zabbix_package_state,
        before => [
          Package[$zabbix_web_package],
          File['/etc/zabbix/web/zabbix.conf.php'],
        ],
      }
    }
    default : {
      $zabbix_web_package = 'zabbix-web'

      package { "zabbix-web-${db}":
        ensure  => $zabbix_package_state,
        before  => Package[$zabbix_web_package],
        require => Class['zabbix::repo'],
      }
    }
  } # END case $::operatingsystem

  file { '/etc/zabbix/web':
    ensure  => directory,
    owner   => 'zabbix',
    group   => 'zabbix',
    mode    => '0755',
    require => Package[$zabbix_web_package],
  }

  package { $zabbix_web_package:
    ensure  => $zabbix_package_state,
    before  => File['/etc/zabbix/web/zabbix.conf.php'],
    require => Class['zabbix::repo'],
  }

  # Webinterface config file
  file { '/etc/zabbix/web/zabbix.conf.php':
    ensure  => present,
    owner   => $apache_user,
    group   => $apache_group,
    mode    => '0640',
    replace => true,
    content => template('zabbix/web/zabbix.conf.php.erb'),
  }

  # Is set to true, it will create the apache vhost.
  if $manage_vhost {
    include ::apache
    # Check if we use ssl. If so, we also create an non ssl
    # vhost for redirect traffic from non ssl to ssl site.
    if $apache_use_ssl {
      # Listen port
      $apache_listen_port = $apache_listenport_ssl

      # We create nonssl vhost for redirecting non ssl
      # traffic to https.
      apache::vhost { "${zabbix_url}_nonssl":
        docroot        => '/usr/share/zabbix',
        manage_docroot => false,
        default_vhost  => $default_vhost,
        port           => $apache_listenport,
        servername     => $zabbix_url,
        ssl            => false,
        rewrites       => [
          {
            comment      => 'redirect all to https',
            rewrite_cond => ['%{SERVER_PORT} !^443$'],
            rewrite_rule => ["^/(.*)$ https://${zabbix_url}/\$1 [L,R]"],
          }
        ],
      }
    } else {
      # So no ssl, so default port 80
      $apache_listen_port = $apache_listenport
    }

    # Check which version of Apache we're using
    if versioncmp($::apache::apache_version, '2.4') >= 0 {
      $directory_allow = { 'require' => 'all granted', }
      $directory_deny = { 'require' => 'all denied', }
    } else {
      $directory_allow = { 'allow' => 'from all', 'order' => 'Allow,Deny', }
      $directory_deny = { 'deny' => 'from all', 'order' => 'Deny,Allow', }
    }

    apache::vhost { $zabbix_url:
      docroot         => '/usr/share/zabbix',
      ip              => $apache_listen_ip,
      port            => $apache_listen_port,
      default_vhost   => $default_vhost,
      add_listen      => true,
      directories     => [
        merge({
          path     => '/usr/share/zabbix',
          provider => 'directory',
        }, $directory_allow),
        merge({
          path     => '/usr/share/zabbix/conf',
          provider => 'directory',
        }, $directory_deny),
        merge({
          path     => '/usr/share/zabbix/api',
          provider => 'directory',
        }, $directory_deny),
        merge({
          path     => '/usr/share/zabbix/include',
          provider => 'directory',
        }, $directory_deny),
        merge({
          path     => '/usr/share/zabbix/include/classes',
          provider => 'directory',
        }, $directory_deny),
      ],
      custom_fragment => "
   php_value max_execution_time ${apache_php_max_execution_time}
   php_value memory_limit ${apache_php_memory_limit}
   php_value post_max_size ${apache_php_post_max_size}
   php_value upload_max_filesize ${apache_php_upload_max_filesize}
   php_value max_input_time ${apache_php_max_input_time}
   php_value always_populate_raw_post_data ${apache_php_always_populate_raw_post_data}
   php_value max_input_vars ${apache_php_max_input_vars}
   # Set correct timezone
   php_value date.timezone ${zabbix_timezone}",
      rewrites        => [
        {
          rewrite_rule => ['^$ /index.php [L]'] }
      ],
      ssl             => $apache_use_ssl,
      ssl_cert        => $apache_ssl_cert,
      ssl_key         => $apache_ssl_key,
      ssl_cipher      => $apache_ssl_cipher,
      ssl_chain       => $apache_ssl_chain,
      require         => Package[$zabbix_web_package],
    }
  } # END if $manage_vhost

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