Class: Puppet::Node

Inherits:
Object show all
Extended by:
Indirector
Includes:
Environment::Helper
Defined in:
lib/puppet/node.rb,
lib/puppet/node/environment.rb

Overview

Just define it, so this class has fewer load dependencies.

Defined Under Namespace

Classes: ActiveRecord, Environment, Exec, Facts, Ldap, Memory, Plain, Rest, StoreConfigs, WriteOnlyYaml, Yaml

Constant Summary

Constants included from Indirector

Indirector::BadNameRegexp

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Indirector

configure_routes, indirects

Methods included from Environment::Helper

#environment=

Constructor Details

#initialize(name, options = {}) ⇒ Node

Returns a new instance of Node.

Raises:

  • (ArgumentError)


67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
# File 'lib/puppet/node.rb', line 67

def initialize(name, options = {})
  raise ArgumentError, "Node names cannot be nil" unless name
  @name = name

  if classes = options[:classes]
    if classes.is_a?(String)
      @classes = [classes]
    else
      @classes = classes
    end
  else
    @classes = []
  end

  @parameters = options[:parameters] || {}

  @facts = options[:facts]

  if env = options[:environment]
    self.environment = env
  end

  @time = Time.now
end

Instance Attribute Details

#classesObject



19
20
21
# File 'lib/puppet/node.rb', line 19

def classes
  @classes
end

#factsObject (readonly)



20
21
22
# File 'lib/puppet/node.rb', line 20

def facts
  @facts
end

#ipaddressObject



19
20
21
# File 'lib/puppet/node.rb', line 19

def ipaddress
  @ipaddress
end

#nameObject



19
20
21
# File 'lib/puppet/node.rb', line 19

def name
  @name
end

#parametersObject



19
20
21
# File 'lib/puppet/node.rb', line 19

def parameters
  @parameters
end

#sourceObject



19
20
21
# File 'lib/puppet/node.rb', line 19

def source
  @source
end

#timeObject (readonly)



20
21
22
# File 'lib/puppet/node.rb', line 20

def time
  @time
end

#trusted_dataObject



19
20
21
# File 'lib/puppet/node.rb', line 19

def trusted_data
  @trusted_data
end

Class Method Details

.from_pson(pson) ⇒ Object

Raises:

  • (ArgumentError)


24
25
26
27
28
29
30
31
32
# File 'lib/puppet/node.rb', line 24

def self.from_pson(pson)
  raise ArgumentError, "No name provided in serialized data" unless name = pson['name']

  node = new(name)
  node.classes = pson['classes']
  node.parameters = pson['parameters']
  node.environment = pson['environment']
  node
end

Instance Method Details

#environmentObject



55
56
57
58
59
60
61
62
63
64
65
# File 'lib/puppet/node.rb', line 55

def environment
  return super if @environment

  if env = parameters["environment"]
    self.environment = env
    return super
  end

  # Else, return the default
  Puppet::Node::Environment.new
end

#fact_mergeObject

Merge the node facts with parameters from the node source.



93
94
95
96
97
98
99
100
101
102
# File 'lib/puppet/node.rb', line 93

def fact_merge
  if @facts = Puppet::Node::Facts.indirection.find(name, :environment => environment)
    @facts.sanitize
    merge(@facts.values)
  end
rescue => detail
  error = Puppet::Error.new("Could not retrieve facts for #{name}: #{detail}")
  error.set_backtrace(detail.backtrace)
  raise error
end

#merge(params) ⇒ Object

Merge any random parameters into our parameter list.



105
106
107
108
109
110
111
# File 'lib/puppet/node.rb', line 105

def merge(params)
  params.each do |name, value|
    @parameters[name] = value unless @parameters.include?(name)
  end

  @parameters["environment"] ||= self.environment.name.to_s
end

#namesObject

Calculate the list of names we might use for looking up our node. This is only used for AST nodes.



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
# File 'lib/puppet/node.rb', line 115

def names
  return [name] if Puppet.settings[:strict_hostname_checking]

  names = []

  names += split_name(name) if name.include?(".")

  # First, get the fqdn
  unless fqdn = parameters["fqdn"]
    if parameters["hostname"] and parameters["domain"]
      fqdn = parameters["hostname"] + "." + parameters["domain"]
    else
      Puppet.warning "Host is missing hostname and/or domain: #{name}"
    end
  end

  # Now that we (might) have the fqdn, add each piece to the name
  # list to search, in order of longest to shortest.
  names += split_name(fqdn) if fqdn

  # And make sure the node name is first, since that's the most
  # likely usage.
  #   The name is usually the Certificate CN, but it can be
  # set to the 'facter' hostname instead.
  if Puppet[:node_name] == 'cert'
    names.unshift name
  else
    names.unshift parameters["hostname"]
  end
  names.uniq
end

#split_name(name) ⇒ Object



147
148
149
150
151
152
153
154
# File 'lib/puppet/node.rb', line 147

def split_name(name)
  list = name.split(".")
  tmp = []
  list.each_with_index do |short, i|
    tmp << list[0..i].join(".")
  end
  tmp.reverse
end

#to_data_hashObject



34
35
36
37
38
39
40
41
42
# File 'lib/puppet/node.rb', line 34

def to_data_hash
  result = {
    'name' => name,
    'environment' => environment.name,
  }
  result['classes'] = classes unless classes.empty?
  result['parameters'] = parameters unless parameters.empty?
  result
end

#to_pson(*args) ⇒ Object



51
52
53
# File 'lib/puppet/node.rb', line 51

def to_pson(*args)
  to_pson_data_hash.to_pson(*args)
end

#to_pson_data_hash(*args) ⇒ Object



44
45
46
47
48
49
# File 'lib/puppet/node.rb', line 44

def to_pson_data_hash(*args)
  {
    'document_type' => "Node",
    'data' =>  to_data_hash,
  }
end