Class | Chef::Formatters::Minimal
In: | lib/chef/formatters/minimal.rb
Parent: | Formatters::Base

## Formatters::Minimal

Shows the progress of the chef run by printing single characters, and displays a summary of updates at the conclusion of the run. For events that don‘t have meaningful status information (loading a file, syncing a cookbook) a dot is printed. For resources, a dot, ‘S’ or ‘U’ is printed if the resource is up to date, skipped by not_if/only_if, or updated, respectively.

### Methods

converge_complete converge_start cookbook_clean_complete cookbook_clean_start cookbook_resolution_complete cookbook_resolution_failed cookbook_resolution_start cookbook_sync_complete cookbook_sync_start file_load_failed file_loaded handler_executed handlers_completed handlers_start library_load_start msg new node_load_completed node_load_failed node_load_start ohai_completed recipe_load_complete registration_completed registration_failed registration_start removed_cookbook_file resource_action_start resource_current_state_loaded resource_failed resource_failed_retriable resource_skipped resource_up_to_date resource_update_applied resource_updated run_completed run_failed run_start skipping_registration synchronized_cookbook updated_cookbook_file

### Attributes

updated_resources | [R] |
updates_by_resource | [R] |

### Public Class methods

new(out, err)

### Public Instance methods

converge_complete()

Called when the converge phase is finished.

converge_start(run_context)

Called before convergence starts

cookbook_clean_complete()

Called when cookbook cleaning is finished.

cookbook_clean_start()

Called before unneeded cookbooks are removed

cookbook_resolution_complete(cookbook_collection)

Called when the cookbook collection is returned from the server.

cookbook_resolution_failed(expanded_run_list, exception)

Called when there is an error getting the cookbook collection from the server.

cookbook_resolution_start(expanded_run_list)

Called before the cookbook collection is fetched from the server.

cookbook_sync_complete()

Called after all cookbooks have been sync‘d.

cookbook_sync_start(cookbook_count)

Called before cookbook sync starts

file_load_failed(path, exception)
file_loaded(path)

Called after a file in a cookbook is loaded.

handler_executed(handler)

Called after an individual handler has run

handlers_completed()

Called after all handlers have executed

handlers_start(handler_count)

Called before handlers run

library_load_start(file_count)

Called when cookbook loading starts.

msg(message)

An uncategorized message. This supports the case that a user needs to pass output that doesn‘t fit into one of the callbacks above. Note that there‘s no semantic information about the content or importance of the message. That means that if you‘re using this too often, you should add a callback for it.

node_load_completed(node, expanded_run_list, config)

Default and override attrs from roles have been computed, but not yet applied. Normal attrs from JSON have been added to the node.

node_load_failed(node_name, exception, config)

Failed to load node data from the server

node_load_start(node_name, config)
ohai_completed(node)

Called right after ohai runs.

recipe_load_complete()

Called when recipes have been loaded.

registration_completed()
registration_failed(node_name, exception, config)

Failed to register this client with the server.

registration_start(node_name, config)

About to attempt to register as `node_name`

removed_cookbook_file(path)

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.

resource_action_start(resource, action, notification_type=nil, notifier=nil)

Called before action is executed on a resource.

resource_current_state_loaded(resource, action, current_resource)

Called after load_current_resource has run.

resource_failed(resource, action, exception)

Called when a resource fails and will not be retried.

resource_failed_retriable(resource, action, retry_count, exception)

Called when a resource fails, but will retry.

resource_skipped(resource, action, conditional)

Called when a resource action has been skipped b/c of a conditional

resource_up_to_date(resource, action)

Called when a resource has no converge actions, e.g., it was already correct.

resource_update_applied(resource, action, update)

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.

resource_updated(resource, action)

Called after a resource has been completely converged.

run_completed(node)

Called at the end of the Chef run.

run_failed(exception)

called at the end of a failed run

run_start(version)

Called at the very start of a Chef Run

skipping_registration(node_name, config)

Already have a client key, assuming this node has registered.

synchronized_cookbook(cookbook_name)

Called when cookbook `cookbook_name` has been sync‘d

updated_cookbook_file(cookbook_name, path)

Called when an individual file in a cookbook has been updated

[Validate]