summaryrefslogtreecommitdiffstats
path: root/lib/puppet/network/handler
diff options
context:
space:
mode:
authorLuke Kanies <luke@madstop.com>2007-08-22 18:03:55 -0500
committerLuke Kanies <luke@madstop.com>2007-08-22 18:03:55 -0500
commit0682d7e473cfd8f2fe6bee9eae0868b846fd0d50 (patch)
treefb66cc4c81e95ee42905410310095b9a8ae23ecc /lib/puppet/network/handler
parentec50484518425ec8ac36f89b087beb27d5a3d2c8 (diff)
parent8b3361afae35cfb65754d7bd9aff5b820ed714f0 (diff)
downloadpuppet-0682d7e473cfd8f2fe6bee9eae0868b846fd0d50.tar.gz
puppet-0682d7e473cfd8f2fe6bee9eae0868b846fd0d50.tar.xz
puppet-0682d7e473cfd8f2fe6bee9eae0868b846fd0d50.zip
Merge branch 'multi_env'
Diffstat (limited to 'lib/puppet/network/handler')
-rw-r--r--lib/puppet/network/handler/configuration.rb209
-rw-r--r--lib/puppet/network/handler/master.rb194
-rw-r--r--lib/puppet/network/handler/node.rb227
-rwxr-xr-xlib/puppet/network/handler/resource.rb4
4 files changed, 494 insertions, 140 deletions
diff --git a/lib/puppet/network/handler/configuration.rb b/lib/puppet/network/handler/configuration.rb
new file mode 100644
index 000000000..7e91d74d6
--- /dev/null
+++ b/lib/puppet/network/handler/configuration.rb
@@ -0,0 +1,209 @@
+require 'openssl'
+require 'puppet'
+require 'puppet/parser/interpreter'
+require 'puppet/sslcertificates'
+require 'xmlrpc/server'
+require 'yaml'
+
+class Puppet::Network::Handler
+ class Configuration < Handler
+ desc "Puppet's configuration compilation interface. Passed a node name
+ or other key, retrieves information about the node (using the ``node_source``)
+ and returns a compiled configuration."
+
+ include Puppet::Util
+
+ attr_accessor :local
+
+ @interface = XMLRPC::Service::Interface.new("configuration") { |iface|
+ iface.add_method("string configuration(string)")
+ iface.add_method("string version()")
+ }
+
+ # Compile a node's configuration.
+ def configuration(key, client = nil, clientip = nil)
+ # Note that this is reasonable, because either their node source should actually
+ # know about the node, or they should be using the ``none`` node source, which
+ # will always return data.
+ unless node = node_handler.details(key)
+ raise Puppet::Error, "Could not find node '%s'" % key
+ end
+
+ # Add any external data to the node.
+ add_node_data(node)
+
+ return translate(compile(node))
+ end
+
+ def initialize(options = {})
+ if options[:Local]
+ @local = options[:Local]
+ else
+ @local = false
+ end
+
+ # Just store the options, rather than creating the interpreter
+ # immediately. Mostly, this is so we can create the interpreter
+ # on-demand, which is easier for testing.
+ @options = options
+
+ set_server_facts
+ end
+
+ # Are we running locally, or are our clients networked?
+ def local?
+ self.local
+ end
+
+ # Return the configuration version.
+ def version(client = nil, clientip = nil)
+ v = interpreter.parsedate
+ # If we can find the node, then store the fact that the node
+ # has checked in.
+ if client and node = node_handler.details(client)
+ update_node_check(node)
+ end
+
+ return v
+ end
+
+ private
+
+ # Add any extra data necessary to the node.
+ def add_node_data(node)
+ # Merge in our server-side facts, so they can be used during compilation.
+ node.fact_merge(@server_facts)
+
+ # Add any specified classes to the node's class list.
+ if classes = @options[:Classes]
+ classes.each do |klass|
+ node.classes << klass
+ end
+ end
+ end
+
+ # Compile the actual configuration.
+ def compile(node)
+ # Pick the benchmark level.
+ if local?
+ level = :none
+ else
+ level = :notice
+ end
+
+ # Ask the interpreter to compile the configuration.
+ config = nil
+ benchmark(level, "Compiled configuration for %s" % node.name) do
+ begin
+ config = interpreter.compile(node)
+ rescue Puppet::Error => detail
+ if Puppet[:trace]
+ puts detail.backtrace
+ end
+ Puppet.err detail
+ raise XMLRPC::FaultException.new(
+ 1, detail.to_s
+ )
+ end
+ end
+
+ return config
+ end
+
+ # Create our interpreter object.
+ def create_interpreter(options)
+ args = {}
+
+ # Allow specification of a code snippet or of a file
+ if code = options[:Code]
+ args[:Code] = code
+ else
+ args[:Manifest] = options[:Manifest] || Puppet[:manifest]
+ end
+
+ args[:Local] = local?
+
+ if options.include?(:UseNodes)
+ args[:UseNodes] = options[:UseNodes]
+ elsif @local
+ args[:UseNodes] = false
+ end
+
+ # This is only used by the cfengine module, or if --loadclasses was
+ # specified in +puppet+.
+ if options.include?(:Classes)
+ args[:Classes] = options[:Classes]
+ end
+
+ return Puppet::Parser::Interpreter.new(args)
+ end
+
+ # Create/return our interpreter.
+ def interpreter
+ unless defined?(@interpreter) and @interpreter
+ @interpreter = create_interpreter(@options)
+ end
+ @interpreter
+ end
+
+ # Create a node handler instance for looking up our nodes.
+ def node_handler
+ unless defined?(@node_handler)
+ @node_handler = Puppet::Network::Handler.handler(:node).new
+ end
+ @node_handler
+ end
+
+ # Initialize our server fact hash; we add these to each client, and they
+ # won't change while we're running, so it's safe to cache the values.
+ def set_server_facts
+ @server_facts = {}
+
+ # Add our server version to the fact list
+ @server_facts["serverversion"] = Puppet.version.to_s
+
+ # And then add the server name and IP
+ {"servername" => "fqdn",
+ "serverip" => "ipaddress"
+ }.each do |var, fact|
+ if value = Facter.value(fact)
+ @server_facts[var] = value
+ else
+ Puppet.warning "Could not retrieve fact %s" % fact
+ end
+ end
+
+ if @server_facts["servername"].nil?
+ host = Facter.value(:hostname)
+ if domain = Facter.value(:domain)
+ @server_facts["servername"] = [host, domain].join(".")
+ else
+ @server_facts["servername"] = host
+ end
+ end
+ end
+
+ # Translate our configuration appropriately for sending back to a client.
+ def translate(config)
+ if local?
+ config
+ else
+ CGI.escape(config.to_yaml(:UseBlock => true))
+ end
+ end
+
+ # Mark that the node has checked in. FIXME this needs to be moved into
+ # the Node class, or somewhere that's got abstract backends.
+ def update_node_check(node)
+ if Puppet.features.rails? and Puppet[:storeconfigs]
+ Puppet::Rails.connect
+
+ host = Puppet::Rails::Host.find_or_create_by_name(node.name)
+ host.last_freshcheck = Time.now
+ host.save
+ end
+ end
+ end
+end
+
+# $Id$
diff --git a/lib/puppet/network/handler/master.rb b/lib/puppet/network/handler/master.rb
index e889c1ba8..acc6c4cda 100644
--- a/lib/puppet/network/handler/master.rb
+++ b/lib/puppet/network/handler/master.rb
@@ -13,7 +13,7 @@ class Puppet::Network::Handler
include Puppet::Util
- attr_accessor :ast, :local
+ attr_accessor :ast
attr_reader :ca
@interface = XMLRPC::Service::Interface.new("puppetmaster") { |iface|
@@ -21,66 +21,9 @@ class Puppet::Network::Handler
iface.add_method("int freshness()")
}
- # FIXME At some point, this should be autodocumenting.
- def addfacts(facts)
- # Add our server version to the fact list
- facts["serverversion"] = Puppet.version.to_s
-
- # And then add the server name and IP
- {"servername" => "fqdn",
- "serverip" => "ipaddress"
- }.each do |var, fact|
- if obj = Facter[fact]
- facts[var] = obj.value
- else
- Puppet.warning "Could not retrieve fact %s" % fact
- end
- end
-
- if facts["servername"].nil?
- host = Facter.value(:hostname)
- if domain = Facter.value(:domain)
- facts["servername"] = [host, domain].join(".")
- else
- facts["servername"] = host
- end
- end
- end
-
- # Manipulate the client name as appropriate.
- def clientname(name, ip, facts)
- # Always use the hostname from Facter.
- client = facts["hostname"]
- clientip = facts["ipaddress"]
- if Puppet[:node_name] == 'cert'
- if name
- client = name
- end
- if ip
- clientip = ip
- end
- end
-
- return client, clientip
- end
-
# Tell a client whether there's a fresh config for it
def freshness(client = nil, clientip = nil)
- if Puppet.features.rails? and Puppet[:storeconfigs]
- Puppet::Rails.connect
-
- host = Puppet::Rails::Host.find_or_create_by_name(client)
- host.last_freshcheck = Time.now
- if clientip and (! host.ip or host.ip == "" or host.ip == "NULL")
- host.ip = clientip
- end
- host.save
- end
- if defined? @interpreter
- return @interpreter.parsedate
- else
- return 0
- end
+ config_handler.version(client, clientip)
end
def initialize(hash = {})
@@ -99,7 +42,7 @@ class Puppet::Network::Handler
@local = false
end
- args[:Local] = @local
+ args[:Local] = local?
if hash.include?(:CA) and hash[:CA]
@ca = Puppet::SSLCertificates::CA.new()
@@ -121,104 +64,79 @@ class Puppet::Network::Handler
args[:Classes] = hash[:Classes]
end
- @interpreter = Puppet::Parser::Interpreter.new(args)
+ @config_handler = Puppet::Network::Handler.handler(:configuration).new(args)
end
+ # Call our various handlers; this handler is getting deprecated.
def getconfig(facts, format = "marshal", client = nil, clientip = nil)
- if @local
- # we don't need to do anything, since we should already
- # have raw objects
- Puppet.debug "Our client is local"
- else
- Puppet.debug "Our client is remote"
+ facts = decode_facts(facts)
+ client, clientip = clientname(client, clientip, facts)
- # XXX this should definitely be done in the protocol, somehow
- case format
- when "marshal":
- Puppet.warning "You should upgrade your client. 'Marshal' will not be supported much longer."
- begin
- facts = Marshal::load(CGI.unescape(facts))
- rescue => detail
- raise XMLRPC::FaultException.new(
- 1, "Could not rebuild facts"
- )
- end
- when "yaml":
- begin
- facts = YAML.load(CGI.unescape(facts))
- rescue => detail
- raise XMLRPC::FaultException.new(
- 1, "Could not rebuild facts"
- )
- end
- else
- raise XMLRPC::FaultException.new(
- 1, "Unavailable config format %s" % format
- )
- end
- end
+ # Pass the facts to the fact handler
+ fact_handler.set(client, facts)
- client, clientip = clientname(client, clientip, facts)
+ # And get the configuration from the config handler
+ return config_handler.configuration(client)
+ end
- # Add any server-side facts to our server.
- addfacts(facts)
+ def local=(val)
+ @local = val
+ config_handler.local = val
+ fact_handler.local = val
+ end
- retobjects = nil
+ private
- # This is hackish, but there's no "silence" option for benchmarks
- # right now
- if @local
- #begin
- retobjects = @interpreter.run(client, facts)
- #rescue Puppet::Error => detail
- # Puppet.err detail
- # raise XMLRPC::FaultException.new(
- # 1, detail.to_s
- # )
- #rescue => detail
- # Puppet.err detail.to_s
- # return ""
- #end
- else
- benchmark(:notice, "Compiled configuration for %s" % client) do
- begin
- retobjects = @interpreter.run(client, facts)
- rescue Puppet::Error => detail
- Puppet.err detail
- raise XMLRPC::FaultException.new(
- 1, detail.to_s
- )
- rescue => detail
- Puppet.err detail.to_s
- return ""
- end
+ # Manipulate the client name as appropriate.
+ def clientname(name, ip, facts)
+ # Always use the hostname from Facter.
+ client = facts["hostname"]
+ clientip = facts["ipaddress"]
+ if Puppet[:node_name] == 'cert'
+ if name
+ client = name
+ end
+ if ip
+ clientip = ip
end
end
+ return client, clientip
+ end
+
+ def config_handler
+ unless defined? @config_handler
+ @config_handler = Puppet::Network::Handler.handler(:config).new :local => local?
+ end
+ @config_handler
+ end
+
+ #
+ def decode_facts(facts)
if @local
- return retobjects
+ # we don't need to do anything, since we should already
+ # have raw objects
+ Puppet.debug "Our client is local"
else
- str = nil
- case format
- when "marshal":
- str = Marshal::dump(retobjects)
- when "yaml":
- str = retobjects.to_yaml(:UseBlock => true)
- else
+ Puppet.debug "Our client is remote"
+
+ begin
+ facts = YAML.load(CGI.unescape(facts))
+ rescue => detail
raise XMLRPC::FaultException.new(
- 1, "Unavailable config format %s" % format
+ 1, "Could not rebuild facts"
)
end
- return CGI.escape(str)
end
+
+ return facts
end
- def local?
- if defined? @local and @local
- return true
- else
- return false
+ def fact_handler
+ unless defined? @fact_handler
+ @fact_handler = Puppet::Network::Handler.handler(:facts).new :local => local?
end
+ @fact_handler
end
end
end
diff --git a/lib/puppet/network/handler/node.rb b/lib/puppet/network/handler/node.rb
new file mode 100644
index 000000000..2c4d3e1b5
--- /dev/null
+++ b/lib/puppet/network/handler/node.rb
@@ -0,0 +1,227 @@
+# Created by Luke A. Kanies on 2007-08-13.
+# Copyright (c) 2007. All rights reserved.
+
+require 'puppet/util'
+require 'puppet/node'
+require 'puppet/util/classgen'
+require 'puppet/util/instance_loader'
+
+# Look up a node, along with all the details about it.
+class Puppet::Network::Handler::Node < Puppet::Network::Handler
+ desc "Retrieve information about nodes."
+
+ # Add a new node source.
+ def self.newnode_source(name, options = {}, &block)
+ name = symbolize(name)
+
+ fact_merge = options[:fact_merge]
+ mod = genmodule(name, :extend => SourceBase, :hash => instance_hash(:node_source), :block => block)
+ mod.send(:define_method, :fact_merge?) do
+ fact_merge
+ end
+ mod
+ end
+
+ # Collect the docs for all of our node sources.
+ def self.node_source_docs
+ docs = ""
+
+ # Use this method so they all get loaded
+ instance_loader(:node_source).loadall
+ loaded_instances(:node_source).sort { |a,b| a.to_s <=> b.to_s }.each do |name|
+ mod = self.node_source(name)
+ docs += "%s\n%s\n" % [name, "-" * name.to_s.length]
+
+ docs += Puppet::Util::Docs.scrub(mod.doc) + "\n\n"
+ end
+
+ docs
+ end
+
+ # List each of the node sources.
+ def self.node_sources
+ instance_loader(:node_source).loadall
+ loaded_instances(:node_source)
+ end
+
+ # Remove a defined node source; basically only used for testing.
+ def self.rm_node_source(name)
+ rmclass(name, :hash => instance_hash(:node_source))
+ end
+
+ extend Puppet::Util::ClassGen
+ extend Puppet::Util::InstanceLoader
+
+ # A simple base module we can use for modifying how our node sources work.
+ module SourceBase
+ include Puppet::Util::Docs
+ end
+
+ @interface = XMLRPC::Service::Interface.new("nodes") { |iface|
+ iface.add_method("string details(key)")
+ iface.add_method("string parameters(key)")
+ iface.add_method("string environment(key)")
+ iface.add_method("string classes(key)")
+ }
+
+ # Set up autoloading and retrieving of reports.
+ autoload :node_source, 'puppet/node_source'
+
+ attr_reader :source
+
+ # Return a given node's classes.
+ def classes(key)
+ if node = details(key)
+ node.classes
+ else
+ nil
+ end
+ end
+
+ # Return an entire node configuration. This uses the 'nodesearch' method
+ # defined in the node_source to look for the node.
+ def details(key, client = nil, clientip = nil)
+ facts = node_facts(key)
+ node = nil
+ names = node_names(key, facts)
+ names.each do |name|
+ name = name.to_s if name.is_a?(Symbol)
+ if node = nodesearch(name)
+ Puppet.info "Found %s in %s" % [name, @source]
+ break
+ end
+ end
+
+ # If they made it this far, we haven't found anything, so look for a
+ # default node.
+ unless node or names.include?("default")
+ if node = nodesearch("default")
+ Puppet.notice "Using default node for %s" % key
+ end
+ end
+
+ if node
+ node.source = @source
+ node.names = names
+
+ # Merge the facts into the parameters.
+ if fact_merge?
+ node.fact_merge(facts)
+ end
+ return node
+ else
+ return nil
+ end
+ end
+
+ # Return a given node's environment.
+ def environment(key, client = nil, clientip = nil)
+ if node = details(key)
+ node.environment
+ else
+ nil
+ end
+ end
+
+ # Create our node lookup tool.
+ def initialize(hash = {})
+ @source = hash[:Source] || Puppet[:node_source]
+
+ unless mod = self.class.node_source(@source)
+ raise ArgumentError, "Unknown node source '%s'" % @source
+ end
+
+ extend(mod)
+
+ super
+
+ # We cache node info for speed
+ @node_cache = {}
+ end
+
+ # Try to retrieve a given node's parameters.
+ def parameters(key, client = nil, clientip = nil)
+ if node = details(key)
+ node.parameters
+ else
+ nil
+ end
+ end
+
+ private
+
+ # Store the node to make things a bit faster.
+ def cache(node)
+ @node_cache[node.name] = node
+ end
+
+ # If the node is cached, return it.
+ def cached?(name)
+ # Don't use cache when the filetimeout is set to 0
+ return false if [0, "0"].include?(Puppet[:filetimeout])
+
+ if node = @node_cache[name] and Time.now - node.time < Puppet[:filetimeout]
+ return node
+ else
+ return false
+ end
+ end
+
+ # Create/cache a fact handler.
+ def fact_handler
+ unless defined?(@fact_handler)
+ @fact_handler = Puppet::Network::Handler.handler(:facts).new
+ end
+ @fact_handler
+ end
+
+ # Short-hand for creating a new node, so the node sources don't need to
+ # specify the constant.
+ def newnode(options)
+ Puppet::Node.new(options)
+ end
+
+ # Look up the node facts from our fact handler.
+ def node_facts(key)
+ if facts = fact_handler.get(key)
+ facts
+ else
+ {}
+ end
+ end
+
+ # Calculate the list of node names we should use for looking
+ # up our node.
+ def node_names(key, facts = nil)
+ facts ||= node_facts(key)
+ names = []
+
+ if hostname = facts["hostname"]
+ unless hostname == key
+ names << hostname
+ end
+ else
+ hostname = key
+ end
+
+ if fqdn = facts["fqdn"]
+ hostname = fqdn
+ names << fqdn
+ end
+
+ # Make sure both the fqdn and the short name of the
+ # host can be used in the manifest
+ if hostname =~ /\./
+ names << hostname.sub(/\..+/,'')
+ elsif domain = facts['domain']
+ names << hostname + "." + domain
+ end
+
+ # Sort the names inversely by name length.
+ names.sort! { |a,b| b.length <=> a.length }
+
+ # And make sure the key is first, since that's the most
+ # likely usage.
+ ([key] + names).uniq
+ end
+end
diff --git a/lib/puppet/network/handler/resource.rb b/lib/puppet/network/handler/resource.rb
index ca492bd81..ac29dce53 100755
--- a/lib/puppet/network/handler/resource.rb
+++ b/lib/puppet/network/handler/resource.rb
@@ -26,7 +26,7 @@ class Puppet::Network::Handler
# Apply a TransBucket as a transaction.
def apply(bucket, format = "yaml", client = nil, clientip = nil)
- unless @local
+ unless local?
begin
case format
when "yaml":
@@ -43,7 +43,7 @@ class Puppet::Network::Handler
# Create a client, but specify the remote machine as the server
# because the class requires it, even though it's unused
- client = Puppet::Network::Client.client(:Master).new(:Server => client||"localhost")
+ client = Puppet::Network::Client.client(:Master).new(:Master => client||"localhost")
# Set the objects
client.objects = component