Class: Puppet::Provider::ElasticPlugin

Inherits:
Puppet::Provider
  • Object
show all
Defined in:
lib/puppet/provider/elastic_plugin.rb

Overview

Generalized parent class for providers that behave like Elasticsearch’s plugin command line tool.

Instance Method Summary collapse

Instance Method Details

#create ⇒ Object

Install this plugin on the host.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/puppet/provider/elastic_plugin.rb', line 106

def create
  commands = []
  commands += proxy_args(@resource[:proxy]) if @resource[:proxy]
  commands << 'install'
  commands << '--batch'
  commands += install_args
  debug("Commands: #{commands.inspect}")

  retry_count = 3
  retry_times = 0
  begin
    with_environment do
      plugin(commands)
    end
  rescue Puppet::ExecutionFailure => e
    retry_times += 1
    debug("Failed to install plugin. Retrying... #{retry_times} of #{retry_count}")
    sleep 2
    retry if retry_times < retry_count
    raise "Failed to install plugin. Received error: #{e.inspect}"
  end
end

#destroy ⇒ Object

Remove this plugin from the host.



130
131
132
133
134
 
# File 'lib/puppet/provider/elastic_plugin.rb', line 130

def destroy
  with_environment do
    plugin(['remove', Puppet_X::Elastic.plugin_name(@resource[:name])])
  end
end

#exists? ⇒ Boolean

Returns:

  • (Boolean) 


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
 
# File 'lib/puppet/provider/elastic_plugin.rb', line 24

def exists?
  # First, attempt to list whether the named plugin exists by finding a
  # plugin descriptor file, which each plugin should have. We must wildcard
  # the name to match meta plugins, see upstream issue for this change:
  # https://github.com/elastic/elasticsearch/pull/28022
  properties_files = Dir[File.join(@resource[:plugin_dir], plugin_path, '**', '*plugin-descriptor.properties')]
  return false if properties_files.empty?

  begin
    # Use the basic name format that the plugin tool supports in order to
    # determine the version from the resource name.
    plugin_version = Puppet_X::Elastic.plugin_version(@resource[:name])

    # Naively parse the Java .properties file to check version equality.
    # Because we don't have the luxury of installing arbitrary gems, perform
    # simple parse with a degree of safety checking in the call chain
    #
    # Note that x-pack installs "meta" plugins which bundle multiple plugins
    # in one. Therefore, we need to find the first "sub" plugin that
    # indicates which version of x-pack this is.
    properties = properties_files.sort.map do |prop_file|
      lines = File.readlines(prop_file).map(&:strip).reject do |line|
        line.start_with?('#') || line.empty?
      end
      lines = lines.map do |property|
        property.split('=')
      end
      lines = lines.select do |pairs|
        pairs.length == 2
      end
      lines.to_h
    end
    properties = properties.find { |prop| prop.key? 'version' }

    if properties && properties['version'] != plugin_version
      debug "Elasticsearch plugin #{@resource[:name]} not version #{plugin_version}, reinstalling"
      destroy
      return false
    end
  rescue ElasticPluginParseFailure
    debug "Failed to parse plugin version for #{@resource[:name]}"
  end

  # If there is no version string, we do not check version equality
  debug "No version found in #{@resource[:name]}, not enforcing any version"
  true
end

#homedir ⇒ Object

Elasticsearch’s home directory.

Returns:

  • String



15
16
17
18
19
20
21
22
 
# File 'lib/puppet/provider/elastic_plugin.rb', line 15

def homedir
  case Facter.value('osfamily')
  when 'OpenBSD'
    '/usr/local/elasticsearch'
  else
    '/usr/share/elasticsearch'
  end
end

#install_args ⇒ Array<String>

Intelligently returns the correct installation arguments for Elasticsearch.

Returns:

  • (Array<String>) —

    arguments to pass to the plugin installation utility



80
81
82
83
84
85
86
87
88
 
# File 'lib/puppet/provider/elastic_plugin.rb', line 80

def install_args
  if !@resource[:url].nil?
    [@resource[:url]]
  elsif !@resource[:source].nil?
    ["file://#{@resource[:source]}"]
  else
    [@resource[:name]]
  end
end

#plugin_path ⇒ Object 



72
73
74
 
# File 'lib/puppet/provider/elastic_plugin.rb', line 72

def plugin_path
  @resource[:plugin_path] || Puppet_X::Elastic.plugin_name(@resource[:name])
end

#proxy_args(url) ⇒ Object

Format proxy arguments for consumption by the elasticsearch plugin management tool (i.e., Java properties).

Returns:

  • Array of flags for command-line tools



95
96
97
98
99
100
101
102
103
 
# File 'lib/puppet/provider/elastic_plugin.rb', line 95

def proxy_args(url)
  parsed = URI(url)
  %w[http https].map do |schema|
    %i[host port user password].map do |param|
      option = parsed.send(param)
      "-D#{schema}.proxy#{param.to_s.capitalize}=#{option}" unless option.nil?
    end
  end.flatten.compact
end

#with_environment(&block) ⇒ Object

Run a command wrapped in necessary env vars



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
 
# File 'lib/puppet/provider/elastic_plugin.rb', line 137

def with_environment(&block)
  env_vars = {
    'ES_JAVA_OPTS' => @resource[:java_opts],
    'ES_PATH_CONF' => @resource[:configdir]
  }
  saved_vars = {}

  # Use 'java_home' param if supplied, otherwise default to Elasticsearch shipped JDK
  env_vars['JAVA_HOME'] = if @resource[:java_home].nil? || @resource[:java_home] == ''
                            "#{homedir}/jdk"
                          else
                            @resource[:java_home]
                          end

  env_vars['ES_JAVA_OPTS'] = env_vars['ES_JAVA_OPTS'].join(' ')

  env_vars.each do |env_var, value|
    saved_vars[env_var] = ENV.fetch(env_var, nil)
    ENV[env_var] = value
  end

  ret = block.yield

  saved_vars.each do |env_var, value|
    ENV[env_var] = value
  end

  ret
end