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::Unprivileged]) (defaults to: undef)

    Elasticsearch HTTP port.

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

    Elasticsearch index name.

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

    Elasticsearch user name.

  • password (Optional[String]) (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_key_path (Optional[Stdlib::Absolutepath]) (defaults to: undef)

    Location of the private key.

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

    Location of the certificate.

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

    Location of the CA certificate.

  • ssl_key (Optional[Stdlib::Base64]) (defaults to: undef)

    The private key in a base64 encoded string to store in spicified ssl_key_path file.

  • ssl_cert (Optional[Stdlib::Base64]) (defaults to: undef)

    The certificate in a base64 encoded to store in spicified ssl_cert_path file.

  • ssl_cacert (Optional[Stdlib::Base64]) (defaults to: undef)

    The CA root certificate in a base64 encoded string to store in spicified ssl_cacert_path file.

  • 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]) (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.



61
62
63
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
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
# File 'manifests/feature/elasticsearch.pp', line 61

class icinga2::feature::elasticsearch(
  Enum['absent', 'present']              $ensure               = present,
  Optional[Stdlib::Host]                 $host                 = undef,
  Optional[Stdlib::Port::Unprivileged]   $port                 = undef,
  Optional[String]                       $index                = undef,
  Optional[String]                       $username             = undef,
  Optional[String]                       $password             = undef,
  Optional[Boolean]                      $enable_ssl           = undef,
  Optional[Stdlib::Absolutepath]         $ssl_key_path         = undef,
  Optional[Stdlib::Absolutepath]         $ssl_cert_path        = undef,
  Optional[Stdlib::Absolutepath]         $ssl_cacert_path      = undef,
  Optional[Stdlib::Base64]               $ssl_key              = undef,
  Optional[Stdlib::Base64]               $ssl_cert             = undef,
  Optional[Stdlib::Base64]               $ssl_cacert           = undef,
  Optional[Boolean]                      $enable_send_perfdata = undef,
  Optional[Icinga2::Interval]            $flush_interval       = undef,
  Optional[Integer]                      $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!')
  }

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

  File {
    owner   => $user,
    group   => $group,
  }

  if $enable_ssl {

    $ssl_dir       = $::icinga2::globals::cert_dir
    $_ssl_key_mode = $::kernel ? {
      'windows' => undef,
      default   => '0600',
    }

    # Set defaults for certificate stuff and/or do validation
    if $ssl_key {
      if $ssl_key_path {
        $_ssl_key_path = $ssl_key_path }
      else {
        $_ssl_key_path = "${ssl_dir}/ElasticsearchWriter_elasticsearch.key"
      }

      $_ssl_key = $::osfamily ? {
        'windows' => regsubst($ssl_key, '\n', "\r\n", 'EMG'),
        default   => $ssl_key,
      }

      file { $_ssl_key_path:
        ensure  => file,
        mode    => $_ssl_key_mode,
        content => $_ssl_key,
        tag     => 'icinga2::config::file',
      }
    } else {
      $_ssl_key_path = $ssl_key_path
    }

    if $ssl_cert {
      if $ssl_cert_path {
        $_ssl_cert_path = $ssl_cert_path }
      else {
        $_ssl_cert_path = "${ssl_dir}/ElasticsearchWriter_elasticsearch.crt"
      }

      $_ssl_cert = $::osfamily ? {
        'windows' => regsubst($ssl_cert, '\n', "\r\n", 'EMG'),
        default   => $ssl_cert,
      }

      file { $_ssl_cert_path:
        ensure  => file,
        content => $_ssl_cert,
        tag     => 'icinga2::config::file',
      }
    } else {
      $_ssl_cert_path = $ssl_cert_path
    }

    if $ssl_cacert {
      if $ssl_cacert_path {
        $_ssl_cacert_path = $ssl_cacert_path }
      else {
        $_ssl_cacert_path = "${ssl_dir}/ElasticsearchWriter_elasticsearch_ca.crt"
      }

      $_ssl_cacert = $::osfamily ? {
        'windows' => regsubst($ssl_cacert, '\n', "\r\n", 'EMG'),
        default   => $ssl_cacert,
      }

      file { $_ssl_cacert_path:
        ensure  => file,
        content => $_ssl_cacert,
        tag     => 'icinga2::config::file',
      }
    } else {
      $_ssl_cacert_path = $ssl_cacert_path
    }

    $attrs_ssl = {
      enable_tls  => $enable_ssl,
      ca_path     => $_ssl_cacert_path,
      cert_path   => $_ssl_cert_path,
      key_path    => $_ssl_key_path,
    }
  } # enable_ssl
  else {
    $attrs_ssl = { enable_tls  => $enable_ssl }
  }

  # The password parameter isn't parsed anymore.
  if $password {
    $_password = "-:\"${password}\""
  } else {
    $_password = undef
  }

  $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(merge($attrs, $attrs_ssl)),
    attrs_list  => keys($attrs),
    target      => "${conf_dir}/features-available/elasticsearch.conf",
    notify      => $_notify,
    order       => 10,
  }

  # import library 'perfdata'
  concat::fragment { 'icinga2::feature::elasticsearch':
    target  => "${conf_dir}/features-available/elasticsearch.conf",
    content => "library \"perfdata\"\n\n",
    order   => '05',
  }

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