Puppet Class: elasticsearch

Defined in:
modules/elasticsearch/manifests/init.pp

Overview

Class: elasticsearch

This class installs/configures/manages the elasticsearch service.

Parameters:

  • $default_instance_params: Parameter overrides for ::elasticsearch::instance

  • $version: Version of elasticsearch to configure. Either 5 or 6. Default: 5.

  • $logstash_host: Host to send logs to

  • $logstash_gelf_port: Tcp port on $logstash_host to send gelf formatted logs to.

  • $logstash_logback_port: Tcp port on localhost to send structured logs to.

  • $logstash_transport: Transport mechanism for logs.

Sample usage:

class { 'elasticsearch':
    default_instance_params => {
        cluster_name => 'labs-search',
    }
}

Parameters:

  • apt_component (String)
  • instances (Optional[Hash[String, Elasticsearch::InstanceParams]]) (defaults to: undef)
  • default_instance_params (Elasticsearch::InstanceParams) (defaults to: {})
  • version (Enum['5', '6', '7']) (defaults to: '5')
  • base_data_dir (Stdlib::Absolutepath) (defaults to: '/srv/elasticsearch')
  • logstash_host (Optional[String]) (defaults to: undef)
  • logstash_gelf_port (Optional[Stdlib::Port]) (defaults to: 12201)
  • logstash_logback_port (Optional[Stdlib::Port]) (defaults to: 11514)
  • logstash_transport (Enum['Gelf', 'syslog']) (defaults to: 'Gelf')
  • rack (Optional[String]) (defaults to: undef)
  • row (Optional[String]) (defaults to: undef)
  • java_home (Optional[String]) (defaults to: undef)
  • s3_username (Optional[String]) (defaults to: undef)
  • s3_password (Optional[String]) (defaults to: undef) 


21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
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
 
# File 'modules/elasticsearch/manifests/init.pp', line 21

class elasticsearch (
    String $apt_component,
    Optional[Hash[String, Elasticsearch::InstanceParams]] $instances = undef,
    Elasticsearch::InstanceParams $default_instance_params           = {},
    Enum['5', '6', '7'] $version                                     = '5',
    Stdlib::Absolutepath $base_data_dir                              = '/srv/elasticsearch',
    Optional[String] $logstash_host                                  = undef,
    Optional[Stdlib::Port] $logstash_gelf_port                       = 12201,
    Optional[Stdlib::Port] $logstash_logback_port                    = 11514,
    Enum['Gelf', 'syslog'] $logstash_transport                       = 'Gelf',
    Optional[String] $rack                                           = undef,
    Optional[String] $row                                            = undef,
    Optional[String] $java_home                                      = undef,
    Optional[String] $s3_username                                    = undef,
    Optional[String] $s3_password                                    = undef,
) {
    # Check arguments and set package
    case $version {
        '5': {
            $package_name = 'elasticsearch'
        }
        /[67]/: {
            $package_name = 'elasticsearch-oss'
        }
        default: { fail("Unsupported elasticsearch version: ${version}") }
    }

    if empty($instances) {
        $cluster_name = $default_instance_params['cluster_name']
        $defaults_for_single_instance = {
            http_port          => 9200,
            transport_tcp_port => 9300,
        }
        $configured_instances = {
            $cluster_name => merge(
                $defaults_for_single_instance,
                $default_instance_params
            )
        }
    } else {
        $configured_instances = $instances.reduce({}) |$agg, $kv_pair| {
            $instance_params = merge($default_instance_params, $kv_pair[1])
            $cluster_name = $instance_params['cluster_name']

            $agg + [$cluster_name, $instance_params]
        }
    }

    class { '::elasticsearch::packages':
        package_name          => $package_name,
        apt_component         => $apt_component,
        # Hack to be resolved in followup patch
        send_logs_to_logstash => $configured_instances.reduce(false) |Boolean $agg, $kv_pair| {
            $agg or pick_default($kv_pair[1]['send_logs_to_logstash'], true)
        }
    }

    class { '::elasticsearch::curator': }

    # Overwrite default env file provided by elastic
    # so that it does not conflict without our var set by systemd unit
    file { '/etc/default/elasticsearch':
        ensure  => file,
        owner   => 'root',
        group   => 'root',
        mode    => '0444',
        content => file('elasticsearch/elasticsearch.env'),
        require => Package['elasticsearch-oss'],
    }

    # main elasticsearch dir, purge it to ensure any undefined config file is removed
    file { '/etc/elasticsearch':
        ensure  => directory,
        owner   => 'root',
        group   => 'root',
        mode    => '0755',
        recurse => true,
        purge   => true,
        force   => true,
    }

    # These files are created when the server is using the default cluster_name
    # and are never written to when the server is using the correct cluster name
    # thus leaving old files with no useful information named in such a way that
    # someone might think they contain useful logs.
    file { '/var/log/elasticsearch/elasticsearch.log':
        ensure => absent,
    }
    file { '/var/log/elasticsearch/elasticsearch_index_indexing_slowlog.log':
        ensure => absent,
    }
    file { '/var/log/elasticsearch/elasticsearch_index_search_slowlog.log':
        ensure => absent,
    }

    file { [ $base_data_dir, '/var/log/elasticsearch' ]:
        ensure  => directory,
        owner   => 'elasticsearch',
        group   => 'elasticsearch',
        mode    => '0755',
        require => Package['elasticsearch-oss'],
    }

    logrotate::rule { 'elasticsearch':
        ensure        => present,
        file_glob     => '/var/log/elasticsearch/*.log',
        frequency     => 'daily',
        copy_truncate => true,
        missing_ok    => true,
        not_if_empty  => true,
        rotate        => 7,
        compress      => true,
    }

    # since we are using our own systemd unit, ensure that the service
    # installed by the debian package is disabled
    service { 'elasticsearch':
        ensure  => stopped,
        enable  => false,
        require => Package['elasticsearch-oss'],
    }

    systemd::unit { "elasticsearch_${version}@.service":
        ensure  => present,
        content => systemd_template("elasticsearch_${version}@"),
    }

    $configured_instances.each |$instance_title, $instance_params| {
        elasticsearch::instance { $instance_title:
            version               => $version,
            base_data_dir         => $base_data_dir,
            logstash_host         => $logstash_host,
            logstash_gelf_port    => $logstash_gelf_port,
            logstash_logback_port => $logstash_logback_port,
            logstash_transport    => $logstash_transport,
            rack                  => $rack,
            row                   => $row,
            s3_username           => $s3_username,
            s3_password           => $s3_password,
            *                     => $instance_params,
        }
    }

    # Cluster management tool
    file { '/usr/local/bin/es-tool':
        ensure  => file,
        owner   => 'root',
        group   => 'root',
        mode    => '0755',
        source  => 'puppet:///modules/elasticsearch/es-tool.py',
        require => Package['python3-elasticsearch'],
    }

    $services_names = $configured_instances.map |$instance_title, $instance_params| {
        "elasticsearch_${version}@${instance_params['cluster_name']}"
    }

    file { '/etc/elasticsearch/instances':
        ensure  => file,
        owner   => 'root',
        group   => 'root',
        mode    => '0444',
        content => join($services_names, "\n"),
    }

}