Called when the converge phase is finished.
# File lib/chef/formatters/doc.rb, line 134 def converge_complete end
Called before convergence starts
# File lib/chef/formatters/doc.rb, line 129 def converge_start(run_context) puts "Converging #{run_context.resource_collection.all_resources.size} resources" end
Called when cookbook cleaning is finished.
# File lib/chef/formatters/doc.rb, line 94 def cookbook_clean_complete end
Called before unneeded cookbooks are removed
# File lib/chef/formatters/doc.rb, line 84 def cookbook_clean_start end
Called when the cookbook collection is returned from the server.
# File lib/chef/formatters/doc.rb, line 80 def cookbook_resolution_complete(cookbook_collection) end
Called when there is an error getting the cookbook collection from the server.
# File lib/chef/formatters/doc.rb, line 75 def cookbook_resolution_failed(expanded_run_list, exception) super end
Called before the cookbook collection is fetched from the server.
# File lib/chef/formatters/doc.rb, line 69 def cookbook_resolution_start(expanded_run_list) puts "resolving cookbooks for run list: #{expanded_run_list.inspect}" end
Called after all cookbooks have been sync'd.
# File lib/chef/formatters/doc.rb, line 112 def cookbook_sync_complete end
Called before cookbook sync starts
# File lib/chef/formatters/doc.rb, line 98 def cookbook_sync_start(cookbook_count) puts "Synchronizing Cookbooks:" end
Called after a file in a cookbook is loaded.
# File lib/chef/formatters/doc.rb, line 121 def file_loaded(path) end
Called when cookbook loading starts.
# File lib/chef/formatters/doc.rb, line 116 def library_load_start(file_count) puts "Compiling Cookbooks..." end
Default and override attrs from roles have been computed, but not yet applied. Normal attrs from JSON have been added to the node.
# File lib/chef/formatters/doc.rb, line 65 def node_load_completed(node, expanded_run_list, config) end
Failed to load node data from the server
# File lib/chef/formatters/doc.rb, line 59 def node_load_failed(node_name, exception, config) super end
# File lib/chef/formatters/doc.rb, line 55 def node_load_start(node_name, config) end
Called right after ohai runs.
# File lib/chef/formatters/doc.rb, line 40 def ohai_completed(node) end
# File lib/chef/formatters/doc.rb, line 181 def output_record(line) end
Called when an assertion declared by a provider fails
# File lib/chef/formatters/doc.rb, line 227 def provider_requirement_failed(action, resource, exception, message) return unless message color = Chef::Config[:why_run] ? :yellow : :red [ message ].flatten.each do |line| @output.color("\n * #{line}", color) end end
Called when recipes have been loaded.
# File lib/chef/formatters/doc.rb, line 125 def recipe_load_complete end
# File lib/chef/formatters/doc.rb, line 52 def registration_completed end
About to attempt to register as node_name
# File lib/chef/formatters/doc.rb, line 48 def registration_start(node_name, config) puts "Creating a new client identity for #{node_name} using the validator key." end
Called after the file at path is removed. It may be removed if the cookbook containing it was removed from the run list, or if the file was removed from the cookbook.
# File lib/chef/formatters/doc.rb, line 90 def removed_cookbook_file(path) end
Called before action is executed on a resource.
# File lib/chef/formatters/doc.rb, line 138 def resource_action_start(resource, action, notification_type=nil, notifier=nil) if resource.cookbook_name && resource.recipe_name resource_recipe = "#{resource.cookbook_name}::#{resource.recipe_name}" else resource_recipe = "<Dynamically Defined Resource>" end if resource_recipe != @current_recipe puts "Recipe: #{resource_recipe}" @current_recipe = resource_recipe end # TODO: info about notifies print " * #{resource} action #{action}" end
# File lib/chef/formatters/doc.rb, line 177 def resource_bypassed(resource, action, provider) puts " (Skipped: whyrun not supported by provider #{provider.class.name})" end
Called when resource current state load is skipped due to the provider not supporting whyrun mode.
# File lib/chef/formatters/doc.rb, line 213 def resource_current_state_load_bypassed(resource, action, current_resource) @output.color("\n * Whyrun not supported for #{resource}, bypassing load.", :yellow) end
Called after load_current_resource has run.
# File lib/chef/formatters/doc.rb, line 169 def resource_current_state_loaded(resource, action, current_resource) end
Called when a resource fails and will not be retried.
# File lib/chef/formatters/doc.rb, line 158 def resource_failed(resource, action, exception) super end
Called when a resource fails, but will retry.
# File lib/chef/formatters/doc.rb, line 154 def resource_failed_retriable(resource, action, retry_count, exception) end
Called when a resource action has been skipped b/c of a conditional
# File lib/chef/formatters/doc.rb, line 163 def resource_skipped(resource, action, conditional) # TODO: more info about conditional puts " (skipped due to #{conditional.positivity})" end
Called when a resource has no converge actions, e.g., it was already correct.
# File lib/chef/formatters/doc.rb, line 173 def resource_up_to_date(resource, action) puts " (up to date)" end
Called when a change has been made to a resource. May be called multiple times per resource, e.g., a file may have its content updated, and then its permissions updated.
# File lib/chef/formatters/doc.rb, line 188 def resource_update_applied(resource, action, update) prefix = Chef::Config[:why_run] ? "Would " : "" Array(update).each do |line| next if line.nil? output_record line if line.kind_of? String @output.color "\n - #{prefix}#{line}", :green elsif line.kind_of? Array # Expanded output - delta # @todo should we have a resource_update_delta callback? line.each do |detail| @output.color "\n #{detail}", :white end end end end
Called after a resource has been completely converged.
# File lib/chef/formatters/doc.rb, line 206 def resource_updated(resource, action) @updated_resources += 1 puts "\n" end
# File lib/chef/formatters/doc.rb, line 23 def run_completed(node) if Chef::Config[:why_run] puts "Chef Client finished, #{@updated_resources} resources would have been updated" else puts "Chef Client finished, #{@updated_resources} resources updated" end end
# File lib/chef/formatters/doc.rb, line 31 def run_failed(exception) if Chef::Config[:why_run] puts "Chef Client failed. #{@updated_resources} resources would have been updated" else puts "Chef Client failed. #{@updated_resources} resources updated" end end
# File lib/chef/formatters/doc.rb, line 19 def run_start(version) puts "Starting Chef Client, version #{version}" end
Already have a client key, assuming this node has registered.
# File lib/chef/formatters/doc.rb, line 44 def skipping_registration(node_name, config) end
Called when cookbook cookbook_name has been sync'd
# File lib/chef/formatters/doc.rb, line 103 def synchronized_cookbook(cookbook_name) puts " - #{cookbook_name}" end
Called when an individual file in a cookbook has been updated
# File lib/chef/formatters/doc.rb, line 108 def updated_cookbook_file(cookbook_name, path) end
Called when a provider makes an assumption after a failed assertion in whyrun mode, in order to allow execution to continue
# File lib/chef/formatters/doc.rb, line 219 def whyrun_assumption(action, resource, message) return unless message [ message ].flatten.each do |line| @output.color("\n * #{line}", :yellow) end end
Generated with the Darkfish Rdoc Generator 2.