Class: Puppet::Indirector::Hiera

Inherits:
Terminus show all
Defined in:
lib/puppet/indirector/hiera.rb

Overview

This class can’t be collapsed into Puppet::Indirector::DataBindings::Hiera because some community plugins rely on this class directly, see PUP-1843. This class is deprecated and will be deleted in a future release. Use ‘Puppet::DataBinding.indirection.terminus(:hiera)` instead.

Direct Known Subclasses

DataBinding::Hiera

Constant Summary collapse

DataBindingExceptions = 
[::StandardError]

Constants included from Util

Util::ALNUM, Util::ALPHA, Util::AbsolutePathPosix, Util::AbsolutePathWindows, Util::DEFAULT_POSIX_MODE, Util::DEFAULT_WINDOWS_MODE, Util::ESCAPED, Util::HEX, Util::HttpProxy, Util::PUPPET_STACK_INSERTION_FRAME, Util::RESERVED, Util::RFC_3986_URI_REGEX, Util::UNRESERVED, Util::UNSAFE

Constants included from Util::POSIX

Util::POSIX::LOCALE_ENV_VARS, Util::POSIX::USER_ENV_VARS

Constants included from Util::SymbolicFileMode

Util::SymbolicFileMode::SetGIDBit, Util::SymbolicFileMode::SetUIDBit, Util::SymbolicFileMode::StickyBit, Util::SymbolicFileMode::SymbolicMode, Util::SymbolicFileMode::SymbolicSpecialToBit

Constants included from Util::Docs

Util::Docs::HEADER_LEVELS

Instance Attribute Summary

Attributes included from Util::Docs

#doc, #nodoc

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Terminus

abstract_terminus?, #allow_remote_requests?, const2name, #indirection, indirection_name, inherited, mark_as_abstract_terminus, #model, model, #name, name2const, register_terminus_class, #require_environment?, terminus_class, terminus_classes, #terminus_type, #validate, #validate_key, #validate_model

Methods included from Util::InstanceLoader

#instance_hash, #instance_load, #instance_loader, #instance_loading?, #loaded_instance, #loaded_instances

Methods included from Util

absolute_path?, benchmark, chuser, clear_environment, create_erb, default_env, deterministic_rand, deterministic_rand_int, exit_on_fail, format_backtrace_array, format_puppetstack_frame, get_env, get_environment, logmethods, merge_environment, path_to_uri, pretty_backtrace, replace_file, resolve_stackframe, rfc2396_escape, safe_posix_fork, set_env, skip_external_facts, symbolizehash, thinmark, uri_encode, uri_query_encode, uri_to_path, uri_unescape, which, withenv, withumask

Methods included from Util::POSIX

#get_posix_field, #gid, groups_of, #idfield, #methodbyid, #methodbyname, #search_posix_field, #uid

Methods included from Util::SymbolicFileMode

#display_mode, #normalize_symbolic_mode, #symbolic_mode_to_int, #valid_symbolic_mode?

Methods included from Util::Docs

#desc, #dochook, #doctable, #markdown_definitionlist, #markdown_header, #nodoc?, #pad, scrub

Constructor Details

#initialize(*args) ⇒ Hiera

Returns a new instance of Hiera.



11
12
13
14
15
16
17
18
 
# File 'lib/puppet/indirector/hiera.rb', line 11

def initialize(*args)
  unless Puppet.features.hiera?
    # TRANSLATORS "Hiera" is the name of a code library and should not be translated
    raise _("Hiera terminus not supported without hiera library")
  end

  super
end

Class Method Details

.hiera ⇒ Object 



94
95
96
 
# File 'lib/puppet/indirector/hiera.rb', line 94

def self.hiera
  @hiera ||= Hiera.new(:config => hiera_config)
end

.hiera_config ⇒ Object 



80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/puppet/indirector/hiera.rb', line 80

def self.hiera_config
  hiera_config = Puppet.settings[:hiera_config]
  config = {}

  if Puppet::FileSystem.exist?(hiera_config)
    config = Hiera::Config.load(hiera_config)
  else
    Puppet.warning _("Config file %{hiera_config} not found, using Hiera defaults") % { hiera_config: hiera_config }
  end

  config[:logger] = 'puppet'
  config
end

Instance Method Details

#find(request) ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/puppet/indirector/hiera.rb', line 26

def find(request)
  not_found = Object.new
  options = request.options
  Puppet.debug { "Performing a hiera indirector lookup of #{request.key} with options #{options.inspect}" }
  value = hiera.lookup(request.key, not_found, Hiera::Scope.new(options[:variables]), nil, convert_merge(options[:merge]))
  throw :no_such_key if value.equal?(not_found)
  value
rescue *DataBindingExceptions => detail
  error = Puppet::DataBinding::LookupError.new("DataBinding 'hiera': #{detail.message}")
  error.set_backtrace(detail.backtrace)
  raise error
end

#hiera ⇒ Object 



98
99
100
 
# File 'lib/puppet/indirector/hiera.rb', line 98

def hiera
  self.class.hiera
end