Puppet Class: icingaweb2

Inherits:
::icingaweb2::params
Defined in:
manifests/init.pp

Overview

Class: icingaweb2

This module installs and configures Icinga Web 2.

Parameters

logging

Whether Icinga Web 2 should log to ‘file’ or to ‘syslog’. Setting ‘none’ disables logging. Defaults to ‘file’.

logging_file

If ‘logging’ is set to ‘file’, this is the target log file. Defaults to ‘/var/log/icingaweb2/icingaweb2.log’.

logging_level

Logging verbosity. Possible values are ‘ERROR’, ‘WARNING’, ‘INFO’ and ‘DEBUG’. Defaults to ‘INFO’.

logging_facility

Logging facility when using syslog. Possible values are ‘user’ or ‘local0’ to ‘local7’.

logging_application

Logging application name when using syslog.

enable_stacktraces

Whether to display stacktraces in the web interface or not. Defaults to ‘false’.

module_path

Path to module sources. Multiple paths must be separated by colon. Defaults to ‘/usr/share/icingaweb2/modules’.

theme

The default theme setting. Users may override this settings. Defaults to ‘icinga’.

theme_disabled

Whether users can change themes or not. Defaults to ‘false`.

manage_repo

When set to true this module will install the packages.icinga.com repository. With this official repo you can get the latest version of Icinga Web. When set to false the operating systems default will be used. Defaults to false. NOTE: will be ignored if manage_package is set to false.

manage_package

If set to ‘false` packages aren’t managed. Defaults to ‘true`.

extra_pacakges

An array of packages to install additionally.

import_schema

Import database scheme. Make sure you have an existing database if you use this option. Defaults to ‘false`

db_type

Database type, can be either ‘mysql` or `pgsql`. This parameter is only used if `import_schema` is `true` or `config_backend` is `db`. Defaults to `mysql`

db_host

Database hostname. This parameter is only used if ‘import_schema` is `true` or `config_backend` is `db`. Defaults to `localhost`

db_port

Port of database host. This parameter is only used if ‘import_schema` is `true` or `config_backend` is `db`. Defaults to `3306`

db_name

Database name. This parameter is only used if ‘import_schema` is `true` or `config_backend` is `db`. Defaults to `icingaweb2`

db_username

Username for database access. This parameter is only used if ‘import_schema` is `true` or `config_backend` is `db`.

db_password

Password for database access. This parameter is only used if ‘import_schema` is `true` or `config_backend` is `db`.

config_backend

The global Icinga Web 2 preferences can either be stored in a database or in ini files. This parameter can either be set to ‘db` or `ini`. Defaults to `ini`

conf_user

By default this module expects Apache2 on the server. You can change the owner of the config files with this parameter. Default is dependent on the platform

default_domain

When using domain-aware authentication, you can set a default domain here.

Examples

Parameters:

  • logging (Enum['file', 'syslog', 'none']) (defaults to: 'file')
  • logging_file (Stdlib::Absolutepath) (defaults to: '/var/log/icingaweb2/icingaweb2.log')
  • logging_level (Enum['ERROR', 'WARNING', 'INFO', 'DEBUG']) (defaults to: 'INFO')
  • logging_facility (Pattern[/user|local[0-7]/]) (defaults to: 'user')
  • logging_application (String) (defaults to: 'icingaweb2')
  • show_stacktraces (Boolean) (defaults to: false)
  • module_path (Stdlib::Absolutepath) (defaults to: $::icingaweb2::params::module_path)
  • theme (String) (defaults to: 'Icinga')
  • theme_disabled (Boolean) (defaults to: false)
  • manage_repo (Boolean) (defaults to: false)
  • manage_package (Boolean) (defaults to: true)
  • extra_packages (Optional[Array[String]]) (defaults to: undef)
  • import_schema (Boolean) (defaults to: false)
  • db_type (Enum['mysql', 'pgsql']) (defaults to: 'mysql')
  • db_host (String) (defaults to: 'localhost')
  • db_port (Integer[1,65535]) (defaults to: 3306)
  • db_name (String) (defaults to: 'icingaweb2')
  • db_username (Optional[String]) (defaults to: undef)
  • db_password (Optional[String]) (defaults to: undef)
  • config_backend (Enum['ini', 'db']) (defaults to: 'ini')
  • conf_user (String) (defaults to: $icingaweb2::params::conf_user)
  • default_domain (Optional[String]) (defaults to: undef)
  • cookie_path (Optional[String]) (defaults to: undef) 


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
 
# File 'manifests/init.pp', line 86

class icingaweb2 (
  Enum['file', 'syslog', 'none']            $logging             = 'file',
  Stdlib::Absolutepath                      $logging_file        = '/var/log/icingaweb2/icingaweb2.log',
  Enum['ERROR', 'WARNING', 'INFO', 'DEBUG'] $logging_level       = 'INFO',
  Pattern[/user|local[0-7]/]                $logging_facility    = 'user',
  String                                    $logging_application = 'icingaweb2',
  Boolean                                   $show_stacktraces    = false,
  Stdlib::Absolutepath                      $module_path         = $::icingaweb2::params::module_path,
  String                                    $theme               = 'Icinga',
  Boolean                                   $theme_disabled      = false,
  Boolean                                   $manage_repo         = false,
  Boolean                                   $manage_package      = true,
  Optional[Array[String]]                   $extra_packages      = undef,
  Boolean                                   $import_schema       = false,
  Enum['mysql', 'pgsql']                    $db_type             = 'mysql',
  String                                    $db_host             = 'localhost',
  Integer[1,65535]                          $db_port             = 3306,
  String                                    $db_name             = 'icingaweb2',
  Optional[String]                          $db_username         = undef,
  Optional[String]                          $db_password         = undef,
  Enum['ini', 'db']                         $config_backend      = 'ini',
  String                                    $conf_user           = $icingaweb2::params::conf_user,
  Optional[String]                          $default_domain      = undef,
  Optional[String]                          $cookie_path         = undef,
) inherits ::icingaweb2::params {

  anchor { '::icingaweb2::begin': }
  -> class { '::icingaweb2::repo': }
  -> class { '::icingaweb2::install': }
  -> class { '::icingaweb2::config': }
  -> anchor { '::icingaweb2::end': }

}