Class: Puppet::Resource::Catalog

Inherits:
Graph::SimpleGraph show all
Extended by:
Indirector
Includes:
Util::Tagging
Defined in:
lib/puppet/resource/catalog.rb

Overview

This class models a node catalog. It is the thing meant to be passed from server to client, and it contains all of the information in the catalog, including the resources and the relationships between them.

Defined Under Namespace

Classes: Compiler, DuplicateResourceError, Json, Msgpack, Rest, StaticCompiler, StoreConfigs, Yaml

Constant Summary

Constants included from Indirector

Indirector::BadNameRegexp

Constants included from Util::Tagging

Util::Tagging::ValidTagRegex

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Indirector

configure_routes, indirects

Methods included from Util::Tagging

#merge_into, #merge_tags, #raw_tagged?, #set_tags, #tag, #tag_if_valid, #tagged?, #tags, #tags=

Methods inherited from Graph::SimpleGraph

#add_edge, #add_relationship, #add_vertex, #adjacent, #dependencies, #dependents, #direct_dependencies_of, #direct_dependents_of, #directed?, #downstream_from_vertex, #each_edge, #edge?, #edges, #edges_between, #find_cycles_in_graph, #instance_variable_get, #leaves, #matching_edges, #path_between, #paths_in_cycle, #remove_edge!, #remove_vertex!, #report_cycles_in_graph, #reversal, #size, #tarjan, #to_a, #to_dot, #to_dot_graph, #to_yaml_properties, #tree_from_vertex, #upstream_from_vertex, #vertex?, #vertices, #walk, #write_cycles_to_graph, #yaml_initialize

Constructor Details

#initialize(name = nil, environment = Puppet::Node::Environment::NONE, code_id = nil) ⇒ Catalog

Returns a new instance of Catalog.



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/puppet/resource/catalog.rb', line 272

def initialize(name = nil, environment = Puppet::Node::Environment::NONE, code_id = nil)
  super()
  @name = name
  @classes = []
  @resource_table = {}
  @resources = []
  @relationship_graph = nil

  @host_config = true
  @environment_instance = environment
  @environment = environment.to_s
  @code_id = code_id

  @aliases = {}

  if block_given?
    yield(self)
    finalize
  end
end

Instance Attribute Details

#client_version ⇒ Object

Some metadata to help us compile and generally respond to the current state.



50
51
52
 
# File 'lib/puppet/resource/catalog.rb', line 50

def client_version
  @client_version
end

#code_id ⇒ Object

The id of the code input to the compiler.



33
34
35
 
# File 'lib/puppet/resource/catalog.rb', line 33

def code_id
  @code_id
end

#environment ⇒ Object

A String representing the environment for this catalog



53
54
55
 
# File 'lib/puppet/resource/catalog.rb', line 53

def environment
  @environment
end

#environment_instance ⇒ Object

The actual environment instance that was used during compilation



56
57
58
 
# File 'lib/puppet/resource/catalog.rb', line 56

def environment_instance
  @environment_instance
end

#from_cache ⇒ Object

Whether this catalog was retrieved from the cache, which affects whether it is written back out again.



47
48
49
 
# File 'lib/puppet/resource/catalog.rb', line 47

def from_cache
  @from_cache
end

#host_config ⇒ Object

Whether this is a host catalog, which behaves very differently. In particular, reports are sent, graphs are made, and state is stored in the state database. If this is set incorrectly, then you often end up in infinite loops, because catalogs are used to make things that the host catalog needs.



43
44
45
 
# File 'lib/puppet/resource/catalog.rb', line 43

def host_config
  @host_config
end

#name ⇒ Object

The host name this is a catalog for.



26
27
28
 
# File 'lib/puppet/resource/catalog.rb', line 26

def name
  @name
end

#retrieval_duration ⇒ Object

How long this catalog took to retrieve. Used for reporting stats.



36
37
38
 
# File 'lib/puppet/resource/catalog.rb', line 36

def retrieval_duration
  @retrieval_duration
end

#server_version ⇒ Object

Some metadata to help us compile and generally respond to the current state.



50
51
52
 
# File 'lib/puppet/resource/catalog.rb', line 50

def server_version
  @server_version
end

#version ⇒ Object

The catalog version. Used for testing whether a catalog is up to date.



30
31
32
 
# File 'lib/puppet/resource/catalog.rb', line 30

def version
  @version
end

Class Method Details

.from_data_hash(data) ⇒ Object 



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/puppet/resource/catalog.rb', line 367

def self.from_data_hash(data)
  result = new(data['name'], Puppet::Node::Environment::NONE)

  if tags = data['tags']
    result.tag(*tags)
  end

  if version = data['version']
    result.version = version
  end

  if code_id = data['code_id']
    result.code_id = code_id
  end

  if environment = data['environment']
    result.environment = environment
    result.environment_instance = Puppet::Node::Environment.remote(environment.to_sym)
  end

  if resources = data['resources']
    result.add_resource(*resources.collect do |res|
      Puppet::Resource.from_data_hash(res)
    end)
  end

  if edges = data['edges']
    edges.each do |edge_hash|
      edge = Puppet::Relationship.from_data_hash(edge_hash)
      unless source = result.resource(edge.source)
        raise ArgumentError, "Could not intern from data: Could not find relationship source #{edge.source.inspect} for #{edge.target.to_s}"
      end
      edge.source = source

      unless target = result.resource(edge.target)
        raise ArgumentError, "Could not intern from data: Could not find relationship target #{edge.target.inspect} for #{edge.source.to_s}"
      end
      edge.target = target

      result.add_edge(edge)
    end
  end

  if classes = data['classes']
    result.add_class(*classes)
  end

  result
end

Instance Method Details

#add_class(*classes) ⇒ Object

Add classes to our class list.



59
60
61
62
63
64
65
66
 
# File 'lib/puppet/resource/catalog.rb', line 59

def add_class(*classes)
  classes.each do |klass|
    @classes << klass
  end

  # Add the class names as tags, too.
  tag(*classes)
end

#add_resource(*resources) ⇒ Object 



98
99
100
101
102
 
# File 'lib/puppet/resource/catalog.rb', line 98

def add_resource(*resources)
  resources.each do |resource|
    add_one_resource(resource)
  end
end

#add_resource_after(other, *resources) ⇒ Object 



88
89
90
91
92
93
94
95
 
# File 'lib/puppet/resource/catalog.rb', line 88

def add_resource_after(other, *resources)
  resources.each do |resource|
    other_title_key = title_key_for_ref(other.ref)
    idx = @resources.index(other_title_key)
    raise ArgumentError, "Cannot add resource #{resource.ref} after #{other.ref} because #{other.ref} is not yet in the catalog" if idx.nil?
    add_one_resource(resource, idx+1)
  end
end

#add_resource_before(other, *resources) ⇒ Object 



79
80
81
82
83
84
85
86
 
# File 'lib/puppet/resource/catalog.rb', line 79

def add_resource_before(other, *resources)
  resources.each do |resource|
    other_title_key = title_key_for_ref(other.ref)
    idx = @resources.index(other_title_key)
    raise ArgumentError, "Cannot add resource #{resource.ref} before #{other.ref} because #{other.ref} is not yet in the catalog" if idx.nil?
    add_one_resource(resource, idx)
  end
end

#alias(resource, key) ⇒ Object

Create an alias for a resource.



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/puppet/resource/catalog.rb', line 150

def alias(resource, key)
  resource.ref =~ /^(.+)\[/
  class_name = $1 || resource.class.name

  newref = [class_name, key].flatten

  if key.is_a? String
    ref_string = "#{class_name}[#{key}]"
    return if ref_string == resource.ref
  end

  # LAK:NOTE It's important that we directly compare the references,
  # because sometimes an alias is created before the resource is
  # added to the catalog, so comparing inside the below if block
  # isn't sufficient.
  if existing = @resource_table[newref]
    return if existing == resource
    resource_declaration = " at #{resource.file}:#{resource.line}" if resource.file and resource.line
    existing_declaration = " at #{existing.file}:#{existing.line}" if existing.file and existing.line
    msg = "Cannot alias #{resource.ref} to #{key.inspect}#{resource_declaration}; resource #{newref.inspect} already declared#{existing_declaration}"
    raise ArgumentError, msg
  end
  @resource_table[newref] = resource
  @aliases[resource.ref] ||= []
  @aliases[resource.ref] << newref
end

#apply(options = {}) {|transaction| ... } ⇒ Puppet::Transaction

Apply our catalog to the local host.

Parameters:

Options Hash (options):

  • :report (Puppet::Transaction::Report) —

    The report object to log this transaction to. This is optional, and the resulting transaction will create a report if not supplied.

  • :tags (Array[String]) —

    Tags used to filter the transaction. If supplied then only resources tagged with any of these tags will be evaluated.

  • :ignoreschedules (Boolean) —

    Ignore schedules when evaluating resources

  • :for_network_device (Boolean) —

    Whether this catalog is for a network device

Yields:

  • (transaction)

Returns:



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/puppet/resource/catalog.rb', line 195

def apply(options = {})
  Puppet::Util::Storage.load if host_config?

  transaction = create_transaction(options)

  begin
    transaction.report.as_logging_destination do
      transaction.evaluate
    end
  ensure
    # Don't try to store state unless we're a host config
    # too recursive.
    Puppet::Util::Storage.store if host_config?
  end

  yield transaction if block_given?

  transaction
end

#classes ⇒ Object 



244
245
246
 
# File 'lib/puppet/resource/catalog.rb', line 244

def classes
  @classes.dup
end

#clear(remove_resources = true) ⇒ Object 



231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/puppet/resource/catalog.rb', line 231

def clear(remove_resources = true)
  super()
  # We have to do this so that the resources clean themselves up.
  @resource_table.values.each { |resource| resource.remove } if remove_resources
  @resource_table.clear
  @resources = []

  if @relationship_graph
    @relationship_graph.clear
    @relationship_graph = nil
  end
end

#container_of(resource) ⇒ A Resource?

Returns the resource that contains the given resource.

Parameters:

  • resource (A Resource) —

    a resource in the catalog

Returns:

  • (A Resource, nil) —

    the resource that contains the given resource



107
108
109
 
# File 'lib/puppet/resource/catalog.rb', line 107

def container_of(resource)
  adjacent(resource, :direction => :in)[0]
end

#create_resource(type, options) ⇒ Object

Create a new resource and register it in the catalog.



249
250
251
252
253
254
255
256
257
 
# File 'lib/puppet/resource/catalog.rb', line 249

def create_resource(type, options)
  unless klass = Puppet::Type.type(type)
    raise ArgumentError, "Unknown resource type #{type}"
  end
  return unless resource = klass.new(options)

  add_resource(resource)
  resource
end

#filter(&block) ⇒ Object

filter out the catalog, applying block to each resource. If the block result is false, the resource will be kept otherwise it will be skipped



443
444
445
446
447
448
449
450
451
452
453
454
455
456
 
# File 'lib/puppet/resource/catalog.rb', line 443

def filter(&block)
  # to_catalog must take place in a context where current_environment is set to the same env as the
  # environment set in the catalog (if it is set)
  # See PUP-3755
  if environment_instance
    Puppet.override({:current_environment => environment_instance}) do
      to_catalog :to_resource, &block
    end
  else
    # If catalog has no environment_instance, hope that the caller has made sure the context has the
    # correct current_environment
    to_catalog :to_resource, &block
  end
end

#finalize ⇒ Object

Make sure all of our resources are “finished”.



260
261
262
263
264
265
266
 
# File 'lib/puppet/resource/catalog.rb', line 260

def finalize
  make_default_resources

  @resource_table.values.each { |resource| resource.finish }

  write_graph(:resources)
end

#host_config? ⇒ Boolean

Returns:

  • (Boolean) 


268
269
270
 
# File 'lib/puppet/resource/catalog.rb', line 268

def host_config?
  host_config
end

#make_default_resources ⇒ Object

Make the default objects necessary for function.



294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/puppet/resource/catalog.rb', line 294

def make_default_resources
  # We have to add the resources to the catalog, or else they won't get cleaned up after
  # the transaction.

  # First create the default scheduling objects
  Puppet::Type.type(:schedule).mkdefaultschedules.each { |res| add_resource(res) unless resource(res.ref) }

  # And filebuckets
  if bucket = Puppet::Type.type(:filebucket).mkdefaultbucket
    add_resource(bucket) unless resource(bucket.ref)
  end
end

#relationship_graph(given_prioritizer = nil) ⇒ Puppet::Graph::RelationshipGraph

The relationship_graph form of the catalog. This contains all of the dependency edges that are used for determining order.

Parameters:

  • given_prioritizer (Puppet::Graph::Prioritizer) (defaults to: nil) —

    The prioritization strategy to use when constructing the relationship graph. Defaults the being determined by the ‘ordering` setting.

Returns:



223
224
225
226
227
228
229
 
# File 'lib/puppet/resource/catalog.rb', line 223

def relationship_graph(given_prioritizer = nil)
  if @relationship_graph.nil?
    @relationship_graph = Puppet::Graph::RelationshipGraph.new(given_prioritizer || prioritizer)
    @relationship_graph.populate_from(self)
  end
  @relationship_graph
end

#remove_resource(*resources) ⇒ Object

Remove the resource from our catalog. Notice that we also call ‘remove’ on the resource, at least until resource classes no longer maintain references to the resource instances.



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/puppet/resource/catalog.rb', line 310

def remove_resource(*resources)
  resources.each do |resource|
    title_key = title_key_for_ref(resource.ref)
    @resource_table.delete(title_key)
    if aliases = @aliases[resource.ref]
      aliases.each { |res_alias| @resource_table.delete(res_alias) }
      @aliases.delete(resource.ref)
    end
    remove_vertex!(resource) if vertex?(resource)
    @relationship_graph.remove_vertex!(resource) if @relationship_graph and @relationship_graph.vertex?(resource)
    @resources.delete(title_key)
    # Only Puppet::Type kind of resources respond to :remove, not Puppet::Resource
    resource.remove if resource.respond_to?(:remove)
  end
end

#resource(type, title = nil) ⇒ Object

Look a resource up by its reference (e.g., File).



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/puppet/resource/catalog.rb', line 327

def resource(type, title = nil)
  # Always create a resource reference, so that it always
  # canonicalizes how we are referring to them.
  attributes = { :environment => environment_instance }
  if title
    res = Puppet::Resource.new(type, title, attributes)
  else
    # If they didn't provide a title, then we expect the first
    # argument to be of the form 'Class[name]', which our
    # Reference class canonicalizes for us.
    res = Puppet::Resource.new(nil, type, attributes)
  end
  res.catalog = self
  title_key      = [res.type, res.title.to_s]
  uniqueness_key = [res.type, res.uniqueness_key].flatten
  result = @resource_table[title_key] || @resource_table[uniqueness_key]
  if ! result && res.resource_type && res.resource_type.is_capability?
    # @todo lutter 2015-03-10: this assumes that it is legal to just
    # mention a capability resource in code and have it automatically
    # made available, even if the current component does not require it
    result = Puppet::Resource::CapabilityFinder.find(environment, code_id, res)
    add_resource(result) if result
  end
  result
end

#resource_keys ⇒ Object 



357
358
359
 
# File 'lib/puppet/resource/catalog.rb', line 357

def resource_keys
  @resource_table.keys
end

#resource_refs ⇒ Object 



353
354
355
 
# File 'lib/puppet/resource/catalog.rb', line 353

def resource_refs
  resource_keys.collect{ |type, name| name.is_a?( String ) ? "#{type}[#{name}]" : nil}.compact
end

#resources ⇒ Object 



361
362
363
364
365
 
# File 'lib/puppet/resource/catalog.rb', line 361

def resources
  @resources.collect do |key|
    @resource_table[key]
  end
end

#title_key_for_ref(ref) ⇒ Object 



68
69
70
71
72
73
74
75
76
77
 
# File 'lib/puppet/resource/catalog.rb', line 68

def title_key_for_ref( ref )
  s = ref.index('[')
  e = ref.rindex(']')
  if s && e && e > s
    a = [ref[0, s], ref[s+1, e-s-1]]
  else
    a = [nil, nil]
  end
  return a
end

#to_data_hash ⇒ Object 



417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/puppet/resource/catalog.rb', line 417

def to_data_hash
  {
    'tags'      => tags,
    'name'      => name,
    'version'   => version,
    'code_id'   => code_id,
    'environment' => environment.to_s,
    'resources' => @resources.collect { |v| @resource_table[v].to_data_hash },
    'edges'     => edges.   collect { |e| e.to_data_hash },
    'classes'   => classes
  }
end

#to_ral ⇒ Object

Convert our catalog into a RAL catalog.



431
432
433
 
# File 'lib/puppet/resource/catalog.rb', line 431

def to_ral
  to_catalog :to_ral
end

#to_resource ⇒ Object

Convert our catalog into a catalog of Puppet::Resource instances.



436
437
438
 
# File 'lib/puppet/resource/catalog.rb', line 436

def to_resource
  to_catalog :to_resource
end

#write_class_file ⇒ Object

Store the classes in the classfile.



459
460
461
462
463
464
465
 
# File 'lib/puppet/resource/catalog.rb', line 459

def write_class_file
  ::File.open(Puppet[:classfile], "w") do |f|
    f.puts classes.join("\n")
  end
rescue => detail
  Puppet.err "Could not create class file #{Puppet[:classfile]}: #{detail}"
end

#write_graph(name) ⇒ Object

Produce the graph files if requested.



485
486
487
488
489
490
 
# File 'lib/puppet/resource/catalog.rb', line 485

def write_graph(name)
  # We only want to graph the main host catalog.
  return unless host_config?

  super
end

#write_resource_file ⇒ Object

Store the list of resources we manage



468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
 
# File 'lib/puppet/resource/catalog.rb', line 468

def write_resource_file
  ::File.open(Puppet[:resourcefile], "w") do |f|
    to_print = resources.map do |resource|
      next unless resource.managed?
      if resource.name_var
        "#{resource.type}[#{resource[resource.name_var]}]"
      else
        "#{resource.ref.downcase}"
      end
    end.compact
    f.puts to_print.join("\n")
  end
rescue => detail
  Puppet.err "Could not create resource file #{Puppet[:resourcefile]}: #{detail}"
end