Class: Puppet::Resource::Catalog

Classes and Modules

Class Puppet::Resource::Catalog::ActiveRecord
Class Puppet::Resource::Catalog::Compiler
Class Puppet::Resource::Catalog::DuplicateResourceError
Class Puppet::Resource::Catalog::Queue
Class Puppet::Resource::Catalog::Rest
Class Puppet::Resource::Catalog::Yaml

Attributes

client_version	[RW]	Some metadata to help us compile and generally respond to the current state.
from_cache	[RW]	Whether this catalog was retrieved from the cache, which affects whether it is written back out again.
host_config	[RW]	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.
name	[RW]	The host name this is a catalog for.
retrieval_duration	[RW]	How long this catalog took to retrieve. Used for reporting stats.
server_version	[RW]	Some metadata to help us compile and generally respond to the current state.
version	[RW]	The catalog version. Used for testing whether a catalog is up to date.

Public Class methods

edge_from_pson(result, edge)

from_pson(data)

new(name = nil) {|self| ...}

resource_from_pson(result, res)

Public Instance methods

add_class(*classes)

Add classes to our class list.

add_resource(*resources) {|resource| ...}

Add one or more resources to our graph and to our resource table. This is actually a relatively complicated method, because it handles multiple aspects of Catalog behaviour:

Add the resource to the resource table
Add the resource to the resource graph
Add the resource to the relationship graph
Add any aliases that make sense for the resource (e.g., name != title)

alias(resource, key)

Create an alias for a resource.

apply(options = {}) {|transaction if block_given?| ...}

Apply our catalog to the local host. Valid options are:

  :tags - set the tags that restrict what resources run
      during the transaction
  :ignoreschedules - tell the transaction to ignore schedules
      when determining the resources to run

applying?()

Are we in the middle of applying the catalog?

classes()

clear(remove_resources = true)

create_resource(type, options)

Create a new resource and register it in the catalog.

dependent_data_expired?(ts)

extract()

Turn our catalog graph into an old-style tree of TransObjects and TransBuckets. LAK:NOTE(20081211): This is a pre-0.25 backward compatibility method. It can be removed as soon as xmlrpc is killed.

filter(&block)

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

finalize()

Make sure all of our resources are "finished".

host_config?()

make_default_resources()

Make the default objects necessary for function.

relationship_graph()

Create a graph of all of the relationships in our catalog.

remove_resource(*resources)

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.

resource(type, title = nil)

Look a resource up by its reference (e.g., File[/etc/passwd]).

resource_keys()

resource_refs()

resources()

title_key_for_ref( ref )

to_pson(*args)

to_pson_data_hash()

to_ral()

Convert our catalog into a RAL catalog.

to_resource()

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