Class: Puppet_X::Elastic::EsVersioning

Inherits:
Object
  • Object
show all
Defined in:
lib/puppet_x/elastic/es_versioning.rb

Overview

Assists with discerning the locally installed version of Elasticsearch. Implemented in a way to be called from native types and providers in order to lazily fetch the package version from various arcane Puppet mechanisms.

Constant Summary collapse

DEFAULT_OPTS =

All of the default options we’ll set for Elasticsearch’s command invocation.

{
  'home' => 'ES_HOME',
  'logs' => 'LOG_DIR',
  'data' => 'DATA_DIR',
  'work' => 'WORK_DIR',
  'conf' => 'CONF_DIR'
}.freeze

Class Method Summary collapse

Class Method Details

.min_version(ver, package_name, catalog) ⇒ Object

Predicate to determine whether a package is at least a certain version.



49
50
51
52
53
 
# File 'lib/puppet_x/elastic/es_versioning.rb', line 49

def self.min_version(ver, package_name, catalog)
  Puppet::Util::Package.versioncmp(
    version(package_name, catalog), ver
  ) >= 0
end

.opt_flag(v5_or_later) ⇒ Object

Get the correct option flag depending on whether Elasticsearch is post version 5.



44
45
46
 
# File 'lib/puppet_x/elastic/es_versioning.rb', line 44

def self.opt_flag(v5_or_later)
  v5_or_later ? 'E' : 'Des.'
end

.opt_flags(package_name, catalog, opts = DEFAULT_OPTS.dup) ⇒ Object

Create an array of command-line flags to append to an ‘elasticsearch` startup command.



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/puppet_x/elastic/es_versioning.rb', line 23

def self.opt_flags(package_name, catalog, opts = DEFAULT_OPTS.dup)
  opt_flag = opt_flag(min_version('5.0.0', package_name, catalog))

  opts.delete 'work' if min_version '5.0.0', package_name, catalog
  opts.delete 'home' if min_version '5.4.0', package_name, catalog

  opt_args = if min_version '6.0.0', package_name, catalog
               []
             else
               opts.map do |k, v|
                 "-#{opt_flag}default.path.#{k}=${#{v}}"
               end.sort
             end

  opt_args << '--quiet' if min_version '5.0.0', package_name, catalog

  [opt_flag, opt_args]
end

.version(package_name, catalog) ⇒ Object

Fetch the package version for a locally installed package.

Raises:

  • (Puppet::Error) 


56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/puppet_x/elastic/es_versioning.rb', line 56

def self.version(package_name, catalog)
  es_pkg = catalog.resource("Package[#{package_name}]")
  raise Puppet::Error, "could not find `Package[#{package_name}]` resource" unless es_pkg

  [
    es_pkg.provider.properties[:version],
    es_pkg.provider.properties[:ensure]
  ].each do |property|
    return property if property.is_a? String
  end
  Puppet.warning("could not find valid version for `Package[#{package_name}]` resource")
  raise ElasticsearchPackageNotFoundError
end