Class: Puppet::Node::WriteOnlyYaml Private

Inherits:
Indirector::Yaml show all
Defined in:
lib/puppet/indirector/node/write_only_yaml.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

This is a WriteOnlyYaml terminus that exists only for the purpose of being able to write node cache data that later can be read by the YAML terminus. The use case this supports is to make it possible to search among the “current nodes” when Puppet DB (recommended) or other central storage of information is not available.

See Also:

Constant Summary

Constants included from Util

Util::AbsolutePathPosix, Util::AbsolutePathWindows, Util::DEFAULT_POSIX_MODE, Util::DEFAULT_WINDOWS_MODE

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

Instance Method Summary collapse

Methods inherited from Indirector::Yaml

#destroy, #path, #save

Methods inherited from Indirector::Terminus

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

Methods included from Util::InstanceLoader

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

Methods included from Util

absolute_path?, benchmark, chuser, clear_environment, default_env, deterministic_rand, deterministic_rand_int, exit_on_fail, get_env, get_environment, logmethods, merge_environment, path_to_uri, pretty_backtrace, replace_file, safe_posix_fork, set_env, symbolizehash, thinmark, uri_encode, uri_query_encode, uri_to_path, which, withenv, withumask

Methods included from Util::POSIX

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

Methods included from Util::SymbolicFileMode

#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 ⇒ WriteOnlyYaml

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of WriteOnlyYaml.



14
15
16
17
 
# File 'lib/puppet/indirector/node/write_only_yaml.rb', line 14

def initialize
  Puppet.warn_once('deprecations', 'Puppet::Node::WriteOnlyYaml', _('Puppet::Node::WriteOnlyYaml is deprecated and will be removed in a future release of Puppet.'))
  super
end

Instance Method Details

#find(request) ⇒ nil

Overridden to always return nil. This is a write only terminus.

Parameters:

  • request (Object) —

    Ignored.

Returns:

  • (nil) —

    This implementation always return nil’



26
27
28
 
# File 'lib/puppet/indirector/node/write_only_yaml.rb', line 26

def find(request)
  nil
end

#search(request) ⇒ nil

Overridden to always return nil. This is a write only terminus.

Parameters:

  • request (Object) —

    Ignored.

Returns:

  • (nil) —

    This implementation always return nil



34
35
36
 
# File 'lib/puppet/indirector/node/write_only_yaml.rb', line 34

def search(request)
  nil
end