Puppet Class: icingaweb2

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

Overview

Class icingaweb2

$admin_permissions

Default:

$admin_users

Default:

$auth_backend

Default:

$auth_ldap_base_dn

LDAP base dn. Default: undef

$auth_ldap_filter

LDAP authentication filter. Default: undef

$auth_ldap_user_class

LDAP authentication user class. Default: inetOrgPerson

$auth_ldap_user_name_attribute

LDAP authentication user name attribute.

Default: uid
$auth_resource

Default:

$config_dir

Location of the main configuration directory. Default: operating system specific.

$config_dir_mode

Posix file mode for configuration directories. Default: 0755.

$config_dir_purge

The $config_dir is purge at each puppet run. Unmanaged puppet file will be lost Default: false.

$config_dir_recurse

Apply the same posix permissions as $config_dir to any directory contained in $config_dir. Default: false.

$config_file_mode

Posix file mode for configuration files. Default: 0644.

$config_group

Posix group for configuration files. Default: operating system specific.

$config_user

Posix user for configuration files. Default: operating system specific.

$git_repo

Source repository containing upstream IcingaWeb2. Default: ‘github.com/Icinga/icingaweb2.git’

$git_revision

Allows git revisions, tags, hashes, … to be specified. Default: undef.

$ido_db

Default:

$ido_db_host

Default:

$ido_db_name

Default:

$ido_db_pass

Default:

$ido_db_port

Default:

$ido_db_user

Default:

$ido_type

Default:

$install_method

Defines how to install install IcingaWeb2. Options: git, package Default: git.

$ldap_bind_dn

LDAP bind dn Default: undef

$ldap_bind_pw

LDAP bind pw Default: undef

$ldap_encryption

LDAP encryption method Allowed values are “starttls” and “ldaps”. Default: undef

$ldap_host

LDAP hostname Default: undef

$ldap_port

LDAP bind port Default: 389

$ldap_root_dn

LDAP root dn Default: undef

$log_application

Default:

$log_level

Default:

$log_method

Default:

$log_resource

Default:

$log_store

Default:

$manage_apache_vhost

Define wether or not this module should manage the virtualhost using Puppetlabs’ apache module. Default: false.

$manage_repo

Add a custom package repository. Default: false.

$manage_user

Defines if user and group should be managed by this module. Set to false if you don’t want user and group to be managed by this module. Default: true.

$pkg_deps

Any dependencies that need to be resolved before installing the main package. Default: operating system specific.

$pkg_ensure

Ensure state for packages. Default: present.

$pkg_list

An array containing the main package and possibly a number of dependencies. Default: operating system specific.

$template_auth

Default: icingaweb2/authentication.ini.erb

$template_config

Default: icingaweb2/config.ini.erb

$template_resources

Default: icingaweb2/resources.ini.erb

$template_roles

Default: icingaweb2/roles.ini.erb

$template_apache

Default: icingaweb2/apache2.ini.erb

$web_db

Default:

$web_db_host

Default:

$web_db_name

Default:

$web_db_pass

Default:

$web_db_port

Default:

$web_db_prefix

Default:

$web_db_user

Default:

$web_root

Default location for when using using git. Default: operating system specific.

$web_type

Default:

$initialize

Whether or not to initialize a db scheme and a user Default : false

Parameters:

  • admin_permissions (Any) (defaults to: $::icingaweb2::params::admin_permissions)
  • admin_users (Any) (defaults to: $::icingaweb2::params::admin_users)
  • auth_backend (Any) (defaults to: $::icingaweb2::params::auth_backend)
  • auth_ldap_base_dn (Any) (defaults to: $::icingaweb2::params::auth_ldap_base_dn)
  • auth_ldap_filter (Any) (defaults to: $::icingaweb2::params::auth_ldap_filter)
  • auth_ldap_user_class (Any) (defaults to: $::icingaweb2::params::auth_ldap_user_class)
  • auth_ldap_user_name_attribute (Any) (defaults to: $::icingaweb2::params::auth_ldap_user_name_attribute)
  • auth_resource (Any) (defaults to: $::icingaweb2::params::auth_resource)
  • config_dir (Any) (defaults to: $::icingaweb2::params::config_dir)
  • config_dir_mode (Any) (defaults to: $::icingaweb2::params::config_dir_mode)
  • config_dir_purge (Any) (defaults to: $::icingaweb2::params::config_dir_purge)
  • config_dir_recurse (Any) (defaults to: $::icingaweb2::params::config_dir_recurse)
  • config_file_mode (Any) (defaults to: $::icingaweb2::params::config_file_mode)
  • config_group (Any) (defaults to: $::icingaweb2::params::config_group)
  • config_user (Any) (defaults to: $::icingaweb2::params::config_user)
  • git_repo (Any) (defaults to: $::icingaweb2::params::git_repo)
  • git_revision (Any) (defaults to: $::icingaweb2::params::git_revision)
  • ido_db (Any) (defaults to: $::icingaweb2::params::ido_db)
  • ido_db_host (Any) (defaults to: $::icingaweb2::params::ido_db_host)
  • ido_db_name (Any) (defaults to: $::icingaweb2::params::ido_db_name)
  • ido_db_pass (Any) (defaults to: $::icingaweb2::params::ido_db_pass)
  • ido_db_port (Any) (defaults to: $::icingaweb2::params::ido_db_port)
  • ido_db_user (Any) (defaults to: $::icingaweb2::params::ido_db_user)
  • ido_type (Any) (defaults to: $::icingaweb2::params::ido_type)
  • install_method (Any) (defaults to: $::icingaweb2::params::install_method)
  • ldap_bind_dn (Any) (defaults to: $::icingaweb2::params::ldap_bind_dn)
  • ldap_bind_pw (Any) (defaults to: $::icingaweb2::params::ldap_bind_pw)
  • ldap_encryption (Any) (defaults to: $::icingaweb2::params::ldap_encryption)
  • ldap_host (Any) (defaults to: $::icingaweb2::params::ldap_host)
  • ldap_port (Any) (defaults to: $::icingaweb2::params::ldap_port)
  • ldap_root_dn (Any) (defaults to: $::icingaweb2::params::ldap_root_dn)
  • log_application (Any) (defaults to: $::icingaweb2::params::log_application)
  • log_level (Any) (defaults to: $::icingaweb2::params::log_level)
  • log_method (Any) (defaults to: $::icingaweb2::params::log_method)
  • log_resource (Any) (defaults to: $::icingaweb2::params::log_resource)
  • log_store (Any) (defaults to: $::icingaweb2::params::log_store)
  • manage_apache_vhost (Any) (defaults to: $::icingaweb2::params::manage_apache_vhost)
  • manage_repo (Any) (defaults to: false)
  • manage_user (Any) (defaults to: $::icingaweb2::params::manage_user)
  • pkg_deps (Any) (defaults to: $::icingaweb2::params::pkg_deps)
  • pkg_ensure (Any) (defaults to: $::icingaweb2::params::pkg_ensure)
  • pkg_list (Any) (defaults to: $::icingaweb2::params::pkg_list)
  • pkg_repo_release_key (Any) (defaults to: undef)
  • pkg_repo_release_metadata_expire (Any) (defaults to: undef)
  • pkg_repo_release_url (Any) (defaults to: undef)
  • pkg_repo_snapshot_key (Any) (defaults to: undef)
  • pkg_repo_snapshot_metadata_expire (Any) (defaults to: undef)
  • pkg_repo_snapshot_url (Any) (defaults to: undef)
  • pkg_repo_version (Any) (defaults to: undef)
  • template_auth (Any) (defaults to: $::icingaweb2::params::template_auth)
  • template_config (Any) (defaults to: $::icingaweb2::params::template_config)
  • template_resources (Any) (defaults to: $::icingaweb2::params::template_resources)
  • template_roles (Any) (defaults to: $::icingaweb2::params::template_roles)
  • template_apache (Any) (defaults to: $::icingaweb2::params::template_apache)
  • web_db (Any) (defaults to: $::icingaweb2::params::web_db)
  • web_db_host (Any) (defaults to: $::icingaweb2::params::web_db_host)
  • web_db_name (Any) (defaults to: $::icingaweb2::params::web_db_name)
  • web_db_pass (Any) (defaults to: $::icingaweb2::params::web_db_pass)
  • web_db_port (Any) (defaults to: $::icingaweb2::params::web_db_port)
  • web_db_prefix (Any) (defaults to: $::icingaweb2::params::web_db_prefix)
  • web_db_user (Any) (defaults to: $::icingaweb2::params::web_db_user)
  • web_root (Any) (defaults to: $::icingaweb2::params::web_root)
  • web_type (Any) (defaults to: $::icingaweb2::params::web_type)
  • initialize (Any) (defaults to: $::icingaweb2::params::initialize) 


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

class icingaweb2 (
  $admin_permissions                 = $::icingaweb2::params::admin_permissions,
  $admin_users                       = $::icingaweb2::params::admin_users,
  $auth_backend                      = $::icingaweb2::params::auth_backend,
  $auth_ldap_base_dn                 = $::icingaweb2::params::auth_ldap_base_dn,
  $auth_ldap_filter                  = $::icingaweb2::params::auth_ldap_filter,
  $auth_ldap_user_class              = $::icingaweb2::params::auth_ldap_user_class,
  $auth_ldap_user_name_attribute     = $::icingaweb2::params::auth_ldap_user_name_attribute,
  $auth_resource                     = $::icingaweb2::params::auth_resource,
  $config_dir                        = $::icingaweb2::params::config_dir,
  $config_dir_mode                   = $::icingaweb2::params::config_dir_mode,
  $config_dir_purge                  = $::icingaweb2::params::config_dir_purge,
  $config_dir_recurse                = $::icingaweb2::params::config_dir_recurse,
  $config_file_mode                  = $::icingaweb2::params::config_file_mode,
  $config_group                      = $::icingaweb2::params::config_group,
  $config_user                       = $::icingaweb2::params::config_user,
  $git_repo                          = $::icingaweb2::params::git_repo,
  $git_revision                      = $::icingaweb2::params::git_revision,
  $ido_db                            = $::icingaweb2::params::ido_db,
  $ido_db_host                       = $::icingaweb2::params::ido_db_host,
  $ido_db_name                       = $::icingaweb2::params::ido_db_name,
  $ido_db_pass                       = $::icingaweb2::params::ido_db_pass,
  $ido_db_port                       = $::icingaweb2::params::ido_db_port,
  $ido_db_user                       = $::icingaweb2::params::ido_db_user,
  $ido_type                          = $::icingaweb2::params::ido_type,
  $install_method                    = $::icingaweb2::params::install_method,
  $ldap_bind_dn                      = $::icingaweb2::params::ldap_bind_dn,
  $ldap_bind_pw                      = $::icingaweb2::params::ldap_bind_pw,
  $ldap_encryption                   = $::icingaweb2::params::ldap_encryption,
  $ldap_host                         = $::icingaweb2::params::ldap_host,
  $ldap_port                         = $::icingaweb2::params::ldap_port,
  $ldap_root_dn                      = $::icingaweb2::params::ldap_root_dn,
  $log_application                   = $::icingaweb2::params::log_application,
  $log_level                         = $::icingaweb2::params::log_level,
  $log_method                        = $::icingaweb2::params::log_method,
  $log_resource                      = $::icingaweb2::params::log_resource,
  $log_store                         = $::icingaweb2::params::log_store,
  $manage_apache_vhost               = $::icingaweb2::params::manage_apache_vhost,
  $manage_repo                       = false,
  $manage_user                       = $::icingaweb2::params::manage_user,
  $pkg_deps                          = $::icingaweb2::params::pkg_deps,
  $pkg_ensure                        = $::icingaweb2::params::pkg_ensure,
  $pkg_list                          = $::icingaweb2::params::pkg_list,
  $pkg_repo_release_key              = undef, # Deprecated
  $pkg_repo_release_metadata_expire  = undef, # Deprecated
  $pkg_repo_release_url              = undef, # Deprecated
  $pkg_repo_snapshot_key             = undef, # Deprecated
  $pkg_repo_snapshot_metadata_expire = undef, # Deprecated
  $pkg_repo_snapshot_url             = undef, # Deprecated
  $pkg_repo_version                  = undef, # Deprecated
  $template_auth                     = $::icingaweb2::params::template_auth,
  $template_config                   = $::icingaweb2::params::template_config,
  $template_resources                = $::icingaweb2::params::template_resources,
  $template_roles                    = $::icingaweb2::params::template_roles,
  $template_apache                   = $::icingaweb2::params::template_apache,
  $web_db                            = $::icingaweb2::params::web_db,
  $web_db_host                       = $::icingaweb2::params::web_db_host,
  $web_db_name                       = $::icingaweb2::params::web_db_name,
  $web_db_pass                       = $::icingaweb2::params::web_db_pass,
  $web_db_port                       = $::icingaweb2::params::web_db_port,
  $web_db_prefix                     = $::icingaweb2::params::web_db_prefix,
  $web_db_user                       = $::icingaweb2::params::web_db_user,
  $web_root                          = $::icingaweb2::params::web_root,
  $web_type                          = $::icingaweb2::params::web_type,
  $initialize                        = $::icingaweb2::params::initialize,
) inherits ::icingaweb2::params {
  class { '::icingaweb2::repo': } ->
  class { '::icingaweb2::install': } ->
  class { '::icingaweb2::config': } ->
  class { '::icingaweb2::initialize': } ->
  Class['::icingaweb2']

  validate_absolute_path($config_dir)
  validate_absolute_path($web_root)
  validate_array($pkg_deps)
  validate_array($pkg_list)
  validate_bool($config_dir_recurse)
  validate_bool($manage_repo)
  validate_bool($manage_user)
  validate_bool($initialize)
  validate_slength($config_dir_mode, 4)
  validate_slength($config_file_mode, 4)
  validate_string($admin_permissions)
  validate_string($admin_users)
  validate_string($auth_backend)
  validate_string($auth_resource)
  validate_string($config_dir_mode)
  validate_string($config_file_mode)
  validate_string($config_group)
  validate_string($config_user)
  validate_string($log_application)
  validate_string($log_level)
  validate_string($log_method)
  validate_string($log_resource)
  validate_string($log_store)
  validate_string($pkg_ensure)
  validate_string($template_auth)
  validate_string($template_config)
  validate_string($template_resources)
  validate_string($template_roles)

  if $::icingaweb2::auth_backend == 'ldap' {
    validate_integer($ldap_port)
    validate_string($auth_ldap_base_dn)
    validate_string($auth_ldap_filter)
    validate_string($auth_ldap_user_class)
    validate_string($auth_ldap_user_name_attribute)
    validate_string($ldap_host)
    validate_string($ldap_bind_dn)
    validate_string($ldap_bind_pw)
    validate_string($ldap_root_dn)
    if $::icingaweb2::ldap_encryption {
      validate_re( $ldap_encryption, '^(ldaps|starttls)$', "\$ldap_encryption must be either 'ldaps' or 'starttls', got '${ldap_encryption}'")
    }
  }

  if $::icingaweb2::manage_apache_vhost {
    validate_string($template_apache)
  }

  validate_re($install_method,
    [
      'git',
      'package',
    ]
  )

  validate_re($pkg_ensure,
    [
      'absent',
      'latest',
      'present',
      'purged',
    ]
  )
}