ExpandNodeObject is the "classic" policy builder implementation. It expands the run_list on a node object and then queries the chef-server to find the correct set of cookbooks, given version constraints of the node's environment.
# File lib/chef/policy_builder/expand_node_object.rb, line 46 def initialize(node_name, ohai_data, json_attribs, override_runlist, events) @node_name = node_name @ohai_data = ohai_data @json_attribs = json_attribs @override_runlist = override_runlist @events = events @node = nil @run_list_expansion = nil end
# File lib/chef/policy_builder/expand_node_object.rb, line 224 def api_service @api_service ||= Chef::REST.new(config[:chef_server_url]) end
Applies environment, external JSON attributes, and override run list to the node, Then expands the run_list.
node<Chef::Node> |
The modified node object. node is modified in place. |
# File lib/chef/policy_builder/expand_node_object.rb, line 107 def build_node # Allow user to override the environment of a node by specifying # a config parameter. if Chef::Config[:environment] && !Chef::Config[:environment].chomp.empty? node.chef_environment(Chef::Config[:environment]) end # consume_external_attrs may add items to the run_list. Save the # expanded run_list, which we will pass to the server later to # determine which versions of cookbooks to use. node.reset_defaults_and_overrides node.consume_external_attrs(ohai_data, @json_attribs) setup_run_list_override expand_run_list Chef::Log.info("Run List is [#{node.run_list}]") Chef::Log.info("Run List expands to [#{@expanded_run_list_with_versions.join(', ')}]") events.node_load_completed(node, @expanded_run_list_with_versions, Chef::Config) node end
# File lib/chef/policy_builder/expand_node_object.rb, line 228 def config Chef::Config end
Expands the node’s run list. Stores the run_list_expansion object for later use.
# File lib/chef/policy_builder/expand_node_object.rb, line 133 def expand_run_list @run_list_expansion = if Chef::Config[:solo] node.expand!('disk') else node.expand!('server') end # @run_list_expansion is a RunListExpansion. # # Convert @expanded_run_list, which is an # Array of Hashes of the form # {:name => NAME, :version_constraint => Chef::VersionConstraint }, # into @expanded_run_list_with_versions, an # Array of Strings of the form # "#{NAME}@#{VERSION}" @expanded_run_list_with_versions = @run_list_expansion.recipes.with_version_constraints_strings @run_list_expansion rescue Exception => e # TODO: wrap/munge exception with useful error output. events.run_list_expand_failed(node, e) raise end
In client-server operation, loads the node state from the server. In chef-solo operation, builds a new node object.
# File lib/chef/policy_builder/expand_node_object.rb, line 85 def load_node events.node_load_start(node_name, Chef::Config) Chef::Log.debug("Building node object for #{node_name}") if Chef::Config[:solo] @node = Chef::Node.build(node_name) else @node = Chef::Node.find_or_create(node_name) end rescue Exception => e # TODO: wrap this exception so useful error info can be given to the # user. events.node_load_failed(node_name, e, Chef::Config) raise end
Ensures runlist override contains RunListItem instances
# File lib/chef/policy_builder/expand_node_object.rb, line 209 def runlist_override_sanity_check! # Convert to array and remove whitespace if override_runlist.is_a?(String) @override_runlist = override_runlist.split(',').map { |e| e.strip } end @override_runlist = [override_runlist].flatten.compact override_runlist.map! do |item| if(item.is_a?(Chef::RunList::RunListItem)) item else Chef::RunList::RunListItem.new(item) end end end
# File lib/chef/policy_builder/expand_node_object.rb, line 57 def setup_run_context(specific_recipes=nil) if Chef::Config[:solo] Chef::Cookbook::FileVendor.on_create { |manifest| Chef::Cookbook::FileSystemFileVendor.new(manifest, Chef::Config[:cookbook_path]) } cl = Chef::CookbookLoader.new(Chef::Config[:cookbook_path]) cl.load_cookbooks cookbook_collection = Chef::CookbookCollection.new(cl) run_context = Chef::RunContext.new(node, cookbook_collection, @events) else Chef::Cookbook::FileVendor.on_create { |manifest| Chef::Cookbook::RemoteFileVendor.new(manifest, api_service) } cookbook_hash = sync_cookbooks cookbook_collection = Chef::CookbookCollection.new(cookbook_hash) run_context = Chef::RunContext.new(node, cookbook_collection, @events) end # TODO: this is not the place for this. It should be in Runner or # CookbookCompiler or something. run_context.load(@run_list_expansion) if specific_recipes specific_recipes.each do |recipe_file| run_context.load_recipe_file(recipe_file) end end run_context end
Internal public API
# File lib/chef/policy_builder/expand_node_object.rb, line 198 def setup_run_list_override runlist_override_sanity_check! unless(override_runlist.empty?) node.override_runlist(*override_runlist) Chef::Log.warn "Run List override has been provided." Chef::Log.warn "Original Run List: [#{node.primary_runlist}]" Chef::Log.warn "Overridden Run List: [#{node.run_list}]" end end
Sync_cookbooks eagerly loads all files except files and templates. It returns the cookbook_hash – the return result from /environments/#{node.chef_environment}/cookbook_versions, which we will use for our run_context.
Hash |
The hash of cookbooks with download URLs as given by the server |
# File lib/chef/policy_builder/expand_node_object.rb, line 163 def sync_cookbooks Chef::Log.debug("Synchronizing cookbooks") begin events.cookbook_resolution_start(@expanded_run_list_with_versions) cookbook_hash = api_service.post("environments/#{node.chef_environment}/cookbook_versions", {:run_list => @expanded_run_list_with_versions}) rescue Exception => e # TODO: wrap/munge exception to provide helpful error output events.cookbook_resolution_failed(@expanded_run_list_with_versions, e) raise else events.cookbook_resolution_complete(cookbook_hash) end synchronizer = Chef::CookbookSynchronizer.new(cookbook_hash, events) synchronizer.sync_cookbooks # register the file cache path in the cookbook path so that CookbookLoader actually picks up the synced cookbooks Chef::Config[:cookbook_path] = File.join(Chef::Config[:file_cache_path], "cookbooks") cookbook_hash end
Indicates whether the policy is temporary, which means an override_runlist was provided. Chef::Client uses this to decide whether to do the final node save at the end of the run or not.
# File lib/chef/policy_builder/expand_node_object.rb, line 190 def temporary_policy? !node.override_runlist.empty? end
Generated with the Darkfish Rdoc Generator 2.