Puppet Class: icinga2::feature::elasticsearch

Defined in:
manifests/feature/elasticsearch.pp

Summary

Configures the Icinga 2 feature elasticsearch.

Overview

Examples:

class { 'icinga2::feature::elasticsearch':
  host     => "10.10.0.15",
  index    => "icinga2"
}

Parameters:

  • ensure (Enum['absent', 'present']) (defaults to: present)

    Set to present enables the feature elasticsearch, absent disables it.

  • host (Optional[Stdlib::Host]) (defaults to: undef)

    Elasticsearch host address.

  • port (Optional[Stdlib::Port]) (defaults to: undef)

    Elasticsearch HTTP port.

  • index (Optional[String[1]]) (defaults to: undef)

    Elasticsearch index name.

  • username (Optional[String[1]]) (defaults to: undef)

    Elasticsearch user name.

  • password (Optional[Icinga::Secret]) (defaults to: undef)

    Elasticsearch user password. The password parameter isn’t parsed anymore.

  • enable_ssl (Optional[Boolean]) (defaults to: undef)

    Either enable or disable SSL. Other SSL parameters are only affected if this is set to ‘true’.

  • ssl_noverify (Optional[Boolean]) (defaults to: undef)

    Disable TLS peer verification. Only valid if ssl is enabled.

  • ssl_key_path (Optional[Stdlib::Absolutepath]) (defaults to: undef)

    Location of the client private key. Only valid if ssl is enabled.

  • ssl_cert_path (Optional[Stdlib::Absolutepath]) (defaults to: undef)

    Location of the client certificate. Only valid if ssl is enabled.

  • ssl_cacert_path (Optional[Stdlib::Absolutepath]) (defaults to: undef)

    Location of the CA certificate. Only valid if ssl is enabled.

  • ssl_key (Optional[Icinga::Secret]) (defaults to: undef)

    The client private key in PEM format. Only valid if ssl is enabled.

  • ssl_cert (Optional[String[1]]) (defaults to: undef)

    The client certificate in PEM format. Only valid if ssl is enabled.

  • ssl_cacert (Optional[String[1]]) (defaults to: undef)

    The CA root certificate in PEM format. Only valid if ssl is enabled.

  • enable_send_perfdata (Optional[Boolean]) (defaults to: undef)

    Whether to send check performance data metrics.

  • flush_interval (Optional[Icinga2::Interval]) (defaults to: undef)

    How long to buffer data points before transferring to Elasticsearch.

  • flush_threshold (Optional[Integer[0]]) (defaults to: undef)

    How many data points to buffer before forcing a transfer to Elasticsearch.

  • enable_ha (Optional[Boolean]) (defaults to: undef)

    Enable the high availability functionality. Only valid in a cluster setup.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
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
119
120
121
122
123
124
125
126
127
128
129
130
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
# File 'manifests/feature/elasticsearch.pp', line 64

class icinga2::feature::elasticsearch (
  Enum['absent', 'present']      $ensure               = present,
  Optional[Stdlib::Host]         $host                 = undef,
  Optional[Stdlib::Port]         $port                 = undef,
  Optional[String[1]]            $index                = undef,
  Optional[String[1]]            $username             = undef,
  Optional[Icinga::Secret]       $password             = undef,
  Optional[Boolean]              $enable_ssl           = undef,
  Optional[Boolean]              $ssl_noverify         = undef,
  Optional[Stdlib::Absolutepath] $ssl_key_path         = undef,
  Optional[Stdlib::Absolutepath] $ssl_cert_path        = undef,
  Optional[Stdlib::Absolutepath] $ssl_cacert_path      = undef,
  Optional[Icinga::Secret]       $ssl_key              = undef,
  Optional[String[1]]            $ssl_cert             = undef,
  Optional[String[1]]            $ssl_cacert           = undef,
  Optional[Boolean]              $enable_send_perfdata = undef,
  Optional[Icinga2::Interval]    $flush_interval       = undef,
  Optional[Integer[0]]           $flush_threshold      = undef,
  Optional[Boolean]              $enable_ha            = undef,
) {
  if ! defined(Class['icinga2']) {
    fail('You must include the icinga2 base class before using any icinga2 feature class!')
  }

  $owner         = $icinga2::globals::user
  $group         = $icinga2::globals::group
  $conf_dir      = $icinga2::globals::conf_dir
  $ssl_dir       = $icinga2::globals::cert_dir

  $_password = if $password =~ Sensitive {
    $password
  } elsif $password =~ String {
    Sensitive($password)
  } else {
    undef
  }

  $_notify       = $ensure ? {
    'present' => Class['icinga2::service'],
    default   => undef,
  }

  if $enable_ssl {
    $cert = icinga::cert::files(
      'ElasticsearchWriter_elasticsearch',
      $ssl_dir,
      $ssl_key_path,
      $ssl_cert_path,
      $ssl_cacert_path,
      $ssl_key,
      $ssl_cert,
      $ssl_cacert,
    )

    $attrs_ssl = {
      'enable_tls'            => true,
      'ssl_insecure_noverify' => $ssl_noverify,
      'ca_path'               => $cert['cacert_file'],
      'cert_path'             => $cert['cert_file'],
      'key_path'              => $cert['key_file'],
    }

    # Workaround, icinga::cert doesn't accept undef values for owner and group!
    if $facts['os']['family'] != 'windows' {
      icinga::cert { 'ElasticsearchWriter_elasticsearch':
        args   => $cert,
        owner  => $owner,
        group  => $group,
        notify => $_notify,
      }
    } else {
      icinga::cert { 'ElasticsearchWriter_elasticsearch':
        args   => $cert,
        owner  => 'foo',
        group  => 'bar',
        notify => $_notify,
      }
    }
  } else {
    $attrs_ssl = {
      'enable_tls'        => undef,
      'insecure_noverify' => undef,
      'ca_path'           => undef,
      'cert_path'         => undef,
      'key_path'          => undef,
    }
    $cert = {}
  }

  $attrs = {
    'host'                   => $host,
    'port'                   => $port,
    'index'                  => $index,
    'username'               => $username,
    'password'               => $_password,
    'enable_send_perfdata'   => $enable_send_perfdata,
    'flush_interval'         => $flush_interval,
    'flush_threshold'        => $flush_threshold,
    'enable_ha'              => $enable_ha,
  }

  # create object
  icinga2::object { 'icinga2::object::ElasticsearchWriter::elasticsearch':
    object_name => 'elasticsearch',
    object_type => 'ElasticsearchWriter',
    attrs       => delete_undef_values($attrs + $attrs_ssl),
    attrs_list  => concat(keys($attrs), keys($attrs_ssl)),
    target      => "${conf_dir}/features-available/elasticsearch.conf",
    notify      => $_notify,
    order       => 10,
  }

  icinga2::feature { 'elasticsearch':
    ensure => $ensure,
  }
}