Class: Chef::EventDispatch::Base
- Inherits:
-
Object
- Object
- Chef::EventDispatch::Base
- Defined in:
- lib/chef/event_dispatch/base.rb
Overview
EventDispatch::Base
EventDispatch::Base is a completely abstract base class that defines the API used by both the classes that collect event information and those that process them.
Direct Known Subclasses
ActionCollection, Compliance::Runner, DataCollector::Reporter, Dispatcher, Chef::EventLoggers::Base, Formatters::Base, ResourceReporter
Instance Method Summary collapse
-
#action_collection_registration(action_collection) ⇒ Object
Callback hook for handlers to grab a reference to the action_collection (sent before compiling cookbooks, consumers can also find it off the run_context.action_collection).
-
#attribute_changed(precedence, keys, value) ⇒ Object
Called when an attribute is changed by simple assignment.
-
#attribute_file_load_failed(path, exception) ⇒ Object
Called when an attribute file fails to load.
-
#attribute_file_loaded(path) ⇒ Object
Called after the attribute file is loaded.
-
#attribute_load_complete ⇒ Object
Called when attribute file loading is finished.
-
#attribute_load_start(attribute_file_count) ⇒ Object
Called before attribute files are loaded.
-
#compliance_input_enabled(input) ⇒ Object
Called when a compliance input is enabled (by include_input).
-
#compliance_input_loaded(input) ⇒ Object
Called when a compliance waiver is found in a cookbook by the cookbook_compiler.
-
#compliance_load_complete ⇒ Object
Called when compliance file loading ends.
-
#compliance_load_start ⇒ Object
Called when compliance file loading starts.
-
#compliance_profile_enabled(profile) ⇒ Object
Called when a compliance profile is enabled (by include_profile).
-
#compliance_profile_loaded(profile) ⇒ Object
Called when a compliance profile is found in a cookbook by the cookbook_compiler.
-
#compliance_waiver_enabled(waiver) ⇒ Object
Called when a compliance waiver is enabled (by include_waiver).
-
#compliance_waiver_loaded(waiver) ⇒ Object
Called when a compliance waiver is found in a cookbook by the cookbook_compiler.
-
#converge_complete ⇒ Object
Called when the converge phase is finished.
-
#converge_failed(exception) ⇒ Object
Called if the converge phase fails.
-
#converge_start(run_context) ⇒ Object
Called before convergence starts.
-
#cookbook_clean_complete ⇒ Object
Called when cookbook cleaning is finished.
-
#cookbook_clean_start ⇒ Object
Called before unneeded cookbooks are removed.
-
#cookbook_compilation_complete(run_context) ⇒ Object
This is called after all cookbook compilation phases are completed.
-
#cookbook_compilation_start(run_context) ⇒ Object
Called immediately after creating the run_context and before any cookbook compilation happens.
-
#cookbook_gem_failed(exception) ⇒ Object
Called when cookbook gem installation fails.
-
#cookbook_gem_finished ⇒ Object
Called when finished installing cookbook gems.
-
#cookbook_gem_installing(gem, version) ⇒ Object
Called when the result of installing the bundle is to install the gem.
-
#cookbook_gem_start(gems) ⇒ Object
Called when starting to collect gems from the cookbooks.
-
#cookbook_gem_using(gem, version) ⇒ Object
Called when the result of installing the bundle is to use the gem.
-
#cookbook_resolution_complete(cookbook_collection) ⇒ Object
Called when the cookbook collection is returned from the server.
-
#cookbook_resolution_failed(expanded_run_list, exception) ⇒ Object
Called when there is an error getting the cookbook collection from the server.
-
#cookbook_resolution_start(expanded_run_list) ⇒ Object
Called before the cookbook collection is fetched from the server.
-
#cookbook_sync_complete ⇒ Object
Called after all cookbooks have been sync’d.
-
#cookbook_sync_failed(cookbooks, exception) ⇒ Object
Called when an error occurs during cookbook sync.
-
#cookbook_sync_start(cookbook_count) ⇒ Object
Called before cookbook sync starts.
-
#definition_file_load_failed(path, exception) ⇒ Object
Called when a resource definition file fails to load.
-
#definition_file_loaded(path) ⇒ Object
Called when a resource definition has been loaded.
-
#definition_load_complete ⇒ Object
Called when resource definitions are done loading.
-
#definition_load_start(definition_file_count) ⇒ Object
Called before resource definitions are loaded.
-
#deprecation(message, location = caller(2..2)[0]) ⇒ Object
Emit a message about something being deprecated.
-
#handler_executed(handler) ⇒ Object
Called after an individual handler has run.
-
#handlers_completed ⇒ Object
Called after all handlers have executed.
-
#handlers_start(handler_count) ⇒ Object
Called before handlers run.
-
#inputs_load_complete ⇒ Object
Called when compliance input loading end.
-
#inputs_load_start ⇒ Object
Called when compliance input loading starts.
-
#key_migration_status(key_migrated = false) ⇒ Object
Called when migrating from a pem on disk to a pem stored in Keychain or Windows Certstore.
-
#library_file_load_failed(path, exception) ⇒ Object
Called when a library file has an error on load.
-
#library_file_loaded(path) ⇒ Object
Called when library file has been loaded.
-
#library_load_complete ⇒ Object
Called when library file loading has finished.
-
#library_load_start(file_count) ⇒ Object
Called when library file loading starts.
-
#lwrp_file_load_failed(path, exception) ⇒ Object
Called after a LWR or LWP file errors on load.
-
#lwrp_file_loaded(path) ⇒ Object
Called after a LWR or LWP has been loaded.
-
#lwrp_load_complete ⇒ Object
Called when LWRPs are finished loading.
-
#lwrp_load_start(lwrp_file_count) ⇒ Object
Called when LWRP loading starts.
-
#msg(message) ⇒ Object
An uncategorized message.
-
#node_load_completed(node, expanded_run_list, config) ⇒ Object
Called after Chef client has loaded the node data.
-
#node_load_failed(node_name, exception, config) ⇒ Object
Failed to load node data from the server.
-
#node_load_start(node_name, config) ⇒ Object
Called before Chef client loads the node data from the server.
-
#node_load_success(node) ⇒ Object
Called once the node is loaded by the policy builder.
-
#ohai_completed(node) ⇒ Object
Called right after ohai runs.
-
#ohai_plugin_file_load_failed(path, exception) ⇒ Object
Called when an ohai plugin file has an error on load.
-
#ohai_plugin_file_loaded(path) ⇒ Object
Called when an ohai plugin file has been loaded.
-
#ohai_plugin_load_complete ⇒ Object
Called when ohai plugin file loading has finished.
-
#ohai_plugin_load_start(file_count) ⇒ Object
Called when ohai plugin file loading starts.
-
#policyfile_loaded(policy) ⇒ Object
Called after the Policyfile was loaded.
-
#profiles_load_complete ⇒ Object
Called when compliance profile loading end.
-
#profiles_load_start ⇒ Object
Called when compliance profile loading starts.
-
#provider_requirement_failed(action, resource, exception, message) ⇒ Object
Called when an assertion declared by a provider fails.
-
#recipe_file_load_failed(path, exception, recipe) ⇒ Object
Called after a recipe file fails to load.
-
#recipe_file_loaded(path, recipe) ⇒ Object
Called after the recipe has been loaded.
-
#recipe_load_complete ⇒ Object
Called when recipes have been loaded.
-
#recipe_load_start(recipe_count) ⇒ Object
Called before recipes are loaded.
-
#recipe_not_found(exception) ⇒ Object
Called when a recipe cannot be resolved.
-
#registration_completed ⇒ Object
Successfully created the private key and registered this client with the server.
-
#registration_failed(node_name, exception, config) ⇒ Object
Failed to register this client with the server.
-
#registration_start(node_name, config) ⇒ Object
About to attempt to create a private key registered to the server with client
node_name
. -
#removed_cookbook_file(path) ⇒ Object
Called after the file at
path
is removed. -
#resource_action_start(resource, action, notification_type = nil, notifier = nil) ⇒ Object
Called before action is executed on a resource.
-
#resource_after_state_loaded(resource, action, after_resource) ⇒ Object
Called after #load_after_resource has run.
-
#resource_bypassed(resource, action, current_resource) ⇒ Object
Called when evaluating a resource that does not support whyrun in whyrun mode.
-
#resource_completed(resource) ⇒ Object
Called when a resource action has been completed.
-
#resource_current_state_load_bypassed(resource, action, current_resource) ⇒ Object
Called when resource current state load is skipped due to the provider not supporting whyrun mode.
-
#resource_current_state_loaded(resource, action, current_resource) ⇒ Object
Called after #load_current_resource has run.
-
#resource_failed(resource, action, exception) ⇒ Object
Called when a resource fails and will not be retried.
-
#resource_failed_retriable(resource, action, retry_count, exception) ⇒ Object
Called when a resource fails, but will retry.
-
#resource_skipped(resource, action, conditional) ⇒ Object
Called when a resource action has been skipped b/c of a conditional.
-
#resource_up_to_date(resource, action) ⇒ Object
Called when a resource has no converge actions, e.g., it was already correct.
-
#resource_update_applied(resource, action, update) ⇒ Object
Called when a change has been made to a resource.
-
#resource_update_progress(resource, current, total, interval) ⇒ Object
Called when a progress notification should be sent to the user to indicate the overall progress of a long running operation, such as a large file download.
-
#resource_updated(resource, action) ⇒ Object
Called after a resource has been completely converged, but only if modifications were made.
-
#run_completed(node, run_status) ⇒ Object
Called at the end a successful Chef run.
-
#run_failed(exception, run_status) ⇒ Object
Called at the end of a failed Chef run.
-
#run_list_expand_failed(node, exception) ⇒ Object
Error expanding the run list.
- #run_list_expanded(run_list_expansion) ⇒ Object
-
#run_start(version, run_status) ⇒ Object
Called at the very start of a Chef Run.
- #run_started(run_status) ⇒ Object
-
#skipping_registration(node_name, config) ⇒ Object
Announce that we’re not going to register the client.
-
#stream_closed(stream, options = {}) ⇒ Object
A stream has closed.
-
#stream_opened(stream, options = {}) ⇒ Object
A stream has opened.
-
#stream_output(stream, output, options = {}) ⇒ Object
A chunk of data from a stream.
-
#synchronized_cookbook(cookbook_name, cookbook) ⇒ Object
Called when cookbook
cookbook
has been sync’d. -
#updated_cookbook_file(cookbook_name, path) ⇒ Object
Called when an individual file in a cookbook has been updated.
-
#waivers_load_complete ⇒ Object
Called when compliance waiver loading end.
-
#waivers_load_start ⇒ Object
Called when compliance waiver loading starts.
-
#whyrun_assumption(action, resource, message) ⇒ Object
Called when a provider makes an assumption after a failed assertion in whyrun mode, in order to allow execution to continue.
Instance Method Details
#action_collection_registration(action_collection) ⇒ Object
Callback hook for handlers to grab a reference to the action_collection (sent before compiling cookbooks, consumers can also find it off the run_context.action_collection)
268 |
# File 'lib/chef/event_dispatch/base.rb', line 268 def action_collection_registration(action_collection); end |
#attribute_changed(precedence, keys, value) ⇒ Object
Called when an attribute is changed by simple assignment
391 |
# File 'lib/chef/event_dispatch/base.rb', line 391 def attribute_changed(precedence, keys, value); end |
#attribute_file_load_failed(path, exception) ⇒ Object
Called when an attribute file fails to load.
228 |
# File 'lib/chef/event_dispatch/base.rb', line 228 def attribute_file_load_failed(path, exception); end |
#attribute_file_loaded(path) ⇒ Object
Called after the attribute file is loaded
225 |
# File 'lib/chef/event_dispatch/base.rb', line 225 def attribute_file_loaded(path); end |
#attribute_load_complete ⇒ Object
Called when attribute file loading is finished
231 |
# File 'lib/chef/event_dispatch/base.rb', line 231 def attribute_load_complete; end |
#attribute_load_start(attribute_file_count) ⇒ Object
Called before attribute files are loaded
222 |
# File 'lib/chef/event_dispatch/base.rb', line 222 def attribute_load_start(attribute_file_count); end |
#compliance_input_enabled(input) ⇒ Object
Called when a compliance input is enabled (by include_input)
219 |
# File 'lib/chef/event_dispatch/base.rb', line 219 def compliance_input_enabled(input); end |
#compliance_input_loaded(input) ⇒ Object
Called when a compliance waiver is found in a cookbook by the cookbook_compiler
210 |
# File 'lib/chef/event_dispatch/base.rb', line 210 def compliance_input_loaded(input); end |
#compliance_load_complete ⇒ Object
Called when compliance file loading ends
183 |
# File 'lib/chef/event_dispatch/base.rb', line 183 def compliance_load_complete; end |
#compliance_load_start ⇒ Object
Called when compliance file loading starts
180 |
# File 'lib/chef/event_dispatch/base.rb', line 180 def compliance_load_start; end |
#compliance_profile_enabled(profile) ⇒ Object
Called when a compliance profile is enabled (by include_profile)
213 |
# File 'lib/chef/event_dispatch/base.rb', line 213 def compliance_profile_enabled(profile); end |
#compliance_profile_loaded(profile) ⇒ Object
Called when a compliance profile is found in a cookbook by the cookbook_compiler
204 |
# File 'lib/chef/event_dispatch/base.rb', line 204 def compliance_profile_loaded(profile); end |
#compliance_waiver_enabled(waiver) ⇒ Object
Called when a compliance waiver is enabled (by include_waiver)
216 |
# File 'lib/chef/event_dispatch/base.rb', line 216 def compliance_waiver_enabled(waiver); end |
#compliance_waiver_loaded(waiver) ⇒ Object
Called when a compliance waiver is found in a cookbook by the cookbook_compiler
207 |
# File 'lib/chef/event_dispatch/base.rb', line 207 def compliance_waiver_loaded(waiver); end |
#converge_complete ⇒ Object
Called when the converge phase is finished.
271 |
# File 'lib/chef/event_dispatch/base.rb', line 271 def converge_complete; end |
#converge_failed(exception) ⇒ Object
Called if the converge phase fails
274 |
# File 'lib/chef/event_dispatch/base.rb', line 274 def converge_failed(exception); end |
#converge_start(run_context) ⇒ Object
Called before convergence starts
264 |
# File 'lib/chef/event_dispatch/base.rb', line 264 def converge_start(run_context); end |
#cookbook_clean_complete ⇒ Object
Called when cookbook cleaning is finished.
104 |
# File 'lib/chef/event_dispatch/base.rb', line 104 def cookbook_clean_complete; end |
#cookbook_clean_start ⇒ Object
Called before unneeded cookbooks are removed
96 |
# File 'lib/chef/event_dispatch/base.rb', line 96 def cookbook_clean_start; end |
#cookbook_compilation_complete(run_context) ⇒ Object
This is called after all cookbook compilation phases are completed.
261 |
# File 'lib/chef/event_dispatch/base.rb', line 261 def cookbook_compilation_complete(run_context); end |
#cookbook_compilation_start(run_context) ⇒ Object
Called immediately after creating the run_context and before any cookbook compilation happens
141 |
# File 'lib/chef/event_dispatch/base.rb', line 141 def cookbook_compilation_start(run_context); end |
#cookbook_gem_failed(exception) ⇒ Object
Called when cookbook gem installation fails
134 |
# File 'lib/chef/event_dispatch/base.rb', line 134 def cookbook_gem_failed(exception); end |
#cookbook_gem_finished ⇒ Object
Called when finished installing cookbook gems
131 |
# File 'lib/chef/event_dispatch/base.rb', line 131 def cookbook_gem_finished; end |
#cookbook_gem_installing(gem, version) ⇒ Object
Called when the result of installing the bundle is to install the gem
125 |
# File 'lib/chef/event_dispatch/base.rb', line 125 def cookbook_gem_installing(gem, version); end |
#cookbook_gem_start(gems) ⇒ Object
Called when starting to collect gems from the cookbooks
122 |
# File 'lib/chef/event_dispatch/base.rb', line 122 def cookbook_gem_start(gems); end |
#cookbook_gem_using(gem, version) ⇒ Object
Called when the result of installing the bundle is to use the gem
128 |
# File 'lib/chef/event_dispatch/base.rb', line 128 def cookbook_gem_using(gem, version); end |
#cookbook_resolution_complete(cookbook_collection) ⇒ Object
Called when the cookbook collection is returned from the server.
93 |
# File 'lib/chef/event_dispatch/base.rb', line 93 def cookbook_resolution_complete(cookbook_collection); end |
#cookbook_resolution_failed(expanded_run_list, exception) ⇒ Object
Called when there is an error getting the cookbook collection from the server.
90 |
# File 'lib/chef/event_dispatch/base.rb', line 90 def cookbook_resolution_failed(, exception); end |
#cookbook_resolution_start(expanded_run_list) ⇒ Object
Called before the cookbook collection is fetched from the server.
86 |
# File 'lib/chef/event_dispatch/base.rb', line 86 def cookbook_resolution_start(); end |
#cookbook_sync_complete ⇒ Object
Called after all cookbooks have been sync’d.
119 |
# File 'lib/chef/event_dispatch/base.rb', line 119 def cookbook_sync_complete; end |
#cookbook_sync_failed(cookbooks, exception) ⇒ Object
Called when an error occurs during cookbook sync
116 |
# File 'lib/chef/event_dispatch/base.rb', line 116 def cookbook_sync_failed(cookbooks, exception); end |
#cookbook_sync_start(cookbook_count) ⇒ Object
Called before cookbook sync starts
107 |
# File 'lib/chef/event_dispatch/base.rb', line 107 def cookbook_sync_start(cookbook_count); end |
#definition_file_load_failed(path, exception) ⇒ Object
Called when a resource definition file fails to load
240 |
# File 'lib/chef/event_dispatch/base.rb', line 240 def definition_file_load_failed(path, exception); end |
#definition_file_loaded(path) ⇒ Object
Called when a resource definition has been loaded
237 |
# File 'lib/chef/event_dispatch/base.rb', line 237 def definition_file_loaded(path); end |
#definition_load_complete ⇒ Object
Called when resource definitions are done loading
243 |
# File 'lib/chef/event_dispatch/base.rb', line 243 def definition_load_complete; end |
#definition_load_start(definition_file_count) ⇒ Object
Called before resource definitions are loaded
234 |
# File 'lib/chef/event_dispatch/base.rb', line 234 def definition_load_start(definition_file_count); end |
#deprecation(message, location = caller(2..2)[0]) ⇒ Object
Emit a message about something being deprecated.
379 |
# File 'lib/chef/event_dispatch/base.rb', line 379 def deprecation(, location = caller(2..2)[0]); end |
#handler_executed(handler) ⇒ Object
Called after an individual handler has run
366 |
# File 'lib/chef/event_dispatch/base.rb', line 366 def handler_executed(handler); end |
#handlers_completed ⇒ Object
Called after all handlers have executed
369 |
# File 'lib/chef/event_dispatch/base.rb', line 369 def handlers_completed; end |
#handlers_start(handler_count) ⇒ Object
Called before handlers run
363 |
# File 'lib/chef/event_dispatch/base.rb', line 363 def handlers_start(handler_count); end |
#inputs_load_complete ⇒ Object
Called when compliance input loading end
195 |
# File 'lib/chef/event_dispatch/base.rb', line 195 def inputs_load_complete; end |
#inputs_load_start ⇒ Object
Called when compliance input loading starts
192 |
# File 'lib/chef/event_dispatch/base.rb', line 192 def inputs_load_start; end |
#key_migration_status(key_migrated = false) ⇒ Object
Called when migrating from a pem on disk to a pem stored in Keychain or Windows Certstore
277 |
# File 'lib/chef/event_dispatch/base.rb', line 277 def key_migration_status(key_migrated = false); end |
#library_file_load_failed(path, exception) ⇒ Object
Called when a library file has an error on load.
150 |
# File 'lib/chef/event_dispatch/base.rb', line 150 def library_file_load_failed(path, exception); end |
#library_file_loaded(path) ⇒ Object
Called when library file has been loaded
147 |
# File 'lib/chef/event_dispatch/base.rb', line 147 def library_file_loaded(path); end |
#library_load_complete ⇒ Object
Called when library file loading has finished
153 |
# File 'lib/chef/event_dispatch/base.rb', line 153 def library_load_complete; end |
#library_load_start(file_count) ⇒ Object
Called when library file loading starts
144 |
# File 'lib/chef/event_dispatch/base.rb', line 144 def library_load_start(file_count); end |
#lwrp_file_load_failed(path, exception) ⇒ Object
Called after a LWR or LWP file errors on load
162 |
# File 'lib/chef/event_dispatch/base.rb', line 162 def lwrp_file_load_failed(path, exception); end |
#lwrp_file_loaded(path) ⇒ Object
Called after a LWR or LWP has been loaded
159 |
# File 'lib/chef/event_dispatch/base.rb', line 159 def lwrp_file_loaded(path); end |
#lwrp_load_complete ⇒ Object
Called when LWRPs are finished loading
165 |
# File 'lib/chef/event_dispatch/base.rb', line 165 def lwrp_load_complete; end |
#lwrp_load_start(lwrp_file_count) ⇒ Object
Called when LWRP loading starts
156 |
# File 'lib/chef/event_dispatch/base.rb', line 156 def lwrp_load_start(lwrp_file_count); end |
#msg(message) ⇒ Object
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.
388 |
# File 'lib/chef/event_dispatch/base.rb', line 388 def msg(); end |
#node_load_completed(node, expanded_run_list, config) ⇒ Object
Called after Chef client has loaded the node data. Default and override attrs from roles have been computed, but not yet applied. Normal attrs from JSON have been added to the node.
79 |
# File 'lib/chef/event_dispatch/base.rb', line 79 def node_load_completed(node, , config); end |
#node_load_failed(node_name, exception, config) ⇒ Object
Failed to load node data from the server
71 |
# File 'lib/chef/event_dispatch/base.rb', line 71 def node_load_failed(node_name, exception, config); end |
#node_load_start(node_name, config) ⇒ Object
Called before Chef client loads the node data from the server
63 |
# File 'lib/chef/event_dispatch/base.rb', line 63 def node_load_start(node_name, config); end |
#node_load_success(node) ⇒ Object
Called once the node is loaded by the policy builder
68 |
# File 'lib/chef/event_dispatch/base.rb', line 68 def node_load_success(node); end |
#ohai_completed(node) ⇒ Object
Called right after ohai runs. NOTE: the node object here is always nil because of when it is called
44 |
# File 'lib/chef/event_dispatch/base.rb', line 44 def ohai_completed(node); end |
#ohai_plugin_file_load_failed(path, exception) ⇒ Object
Called when an ohai plugin file has an error on load.
174 |
# File 'lib/chef/event_dispatch/base.rb', line 174 def ohai_plugin_file_load_failed(path, exception); end |
#ohai_plugin_file_loaded(path) ⇒ Object
Called when an ohai plugin file has been loaded
171 |
# File 'lib/chef/event_dispatch/base.rb', line 171 def ohai_plugin_file_loaded(path); end |
#ohai_plugin_load_complete ⇒ Object
Called when ohai plugin file loading has finished
177 |
# File 'lib/chef/event_dispatch/base.rb', line 177 def ohai_plugin_load_complete; end |
#ohai_plugin_load_start(file_count) ⇒ Object
Called when ohai plugin file loading starts
168 |
# File 'lib/chef/event_dispatch/base.rb', line 168 def ohai_plugin_load_start(file_count); end |
#policyfile_loaded(policy) ⇒ Object
Called after the Policyfile was loaded. This event only occurs when chef is in policyfile mode.
83 |
# File 'lib/chef/event_dispatch/base.rb', line 83 def policyfile_loaded(policy); end |
#profiles_load_complete ⇒ Object
Called when compliance profile loading end
189 |
# File 'lib/chef/event_dispatch/base.rb', line 189 def profiles_load_complete; end |
#profiles_load_start ⇒ Object
Called when compliance profile loading starts
186 |
# File 'lib/chef/event_dispatch/base.rb', line 186 def profiles_load_start; end |
#provider_requirement_failed(action, resource, exception, message) ⇒ Object
Called when an assertion declared by a provider fails
372 |
# File 'lib/chef/event_dispatch/base.rb', line 372 def provider_requirement_failed(action, resource, exception, ); end |
#recipe_file_load_failed(path, exception, recipe) ⇒ Object
Called after a recipe file fails to load
252 |
# File 'lib/chef/event_dispatch/base.rb', line 252 def recipe_file_load_failed(path, exception, recipe); end |
#recipe_file_loaded(path, recipe) ⇒ Object
Called after the recipe has been loaded
249 |
# File 'lib/chef/event_dispatch/base.rb', line 249 def recipe_file_loaded(path, recipe); end |
#recipe_load_complete ⇒ Object
Called when recipes have been loaded.
258 |
# File 'lib/chef/event_dispatch/base.rb', line 258 def recipe_load_complete; end |
#recipe_load_start(recipe_count) ⇒ Object
Called before recipes are loaded
246 |
# File 'lib/chef/event_dispatch/base.rb', line 246 def recipe_load_start(recipe_count); end |
#recipe_not_found(exception) ⇒ Object
Called when a recipe cannot be resolved
255 |
# File 'lib/chef/event_dispatch/base.rb', line 255 def recipe_not_found(exception); end |
#registration_completed ⇒ Object
Successfully created the private key and registered this client with the server.
57 |
# File 'lib/chef/event_dispatch/base.rb', line 57 def registration_completed; end |
#registration_failed(node_name, exception, config) ⇒ Object
Failed to register this client with the server.
60 |
# File 'lib/chef/event_dispatch/base.rb', line 60 def registration_failed(node_name, exception, config); end |
#registration_start(node_name, config) ⇒ Object
About to attempt to create a private key registered to the server with client node_name
.
53 |
# File 'lib/chef/event_dispatch/base.rb', line 53 def registration_start(node_name, config); end |
#removed_cookbook_file(path) ⇒ Object
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.
101 |
# File 'lib/chef/event_dispatch/base.rb', line 101 def removed_cookbook_file(path); end |
#resource_action_start(resource, action, notification_type = nil, notifier = nil) ⇒ Object
Called before action is executed on a resource.
307 |
# File 'lib/chef/event_dispatch/base.rb', line 307 def resource_action_start(resource, action, notification_type = nil, notifier = nil); end |
#resource_after_state_loaded(resource, action, after_resource) ⇒ Object
Called after #load_after_resource has run.
316 |
# File 'lib/chef/event_dispatch/base.rb', line 316 def resource_after_state_loaded(resource, action, after_resource); end |
#resource_bypassed(resource, action, current_resource) ⇒ Object
Called when evaluating a resource that does not support whyrun in whyrun mode
323 |
# File 'lib/chef/event_dispatch/base.rb', line 323 def resource_bypassed(resource, action, current_resource); end |
#resource_completed(resource) ⇒ Object
Called when a resource action has been completed
349 |
# File 'lib/chef/event_dispatch/base.rb', line 349 def resource_completed(resource); end |
#resource_current_state_load_bypassed(resource, action, current_resource) ⇒ Object
Called when resource current state load is skipped due to the provider not supporting whyrun mode.
320 |
# File 'lib/chef/event_dispatch/base.rb', line 320 def resource_current_state_load_bypassed(resource, action, current_resource); end |
#resource_current_state_loaded(resource, action, current_resource) ⇒ Object
Called after #load_current_resource has run.
313 |
# File 'lib/chef/event_dispatch/base.rb', line 313 def resource_current_state_loaded(resource, action, current_resource); end |
#resource_failed(resource, action, exception) ⇒ Object
Called when a resource fails and will not be retried.
339 |
# File 'lib/chef/event_dispatch/base.rb', line 339 def resource_failed(resource, action, exception); end |
#resource_failed_retriable(resource, action, retry_count, exception) ⇒ Object
Called when a resource fails, but will retry.
336 |
# File 'lib/chef/event_dispatch/base.rb', line 336 def resource_failed_retriable(resource, action, retry_count, exception); end |
#resource_skipped(resource, action, conditional) ⇒ Object
Called when a resource action has been skipped b/c of a conditional
310 |
# File 'lib/chef/event_dispatch/base.rb', line 310 def resource_skipped(resource, action, conditional); end |
#resource_up_to_date(resource, action) ⇒ Object
Called when a resource has no converge actions, e.g., it was already correct.
346 |
# File 'lib/chef/event_dispatch/base.rb', line 346 def resource_up_to_date(resource, action); end |
#resource_update_applied(resource, action, update) ⇒ Object
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.
328 |
# File 'lib/chef/event_dispatch/base.rb', line 328 def resource_update_applied(resource, action, update); end |
#resource_update_progress(resource, current, total, interval) ⇒ Object
Called when a progress notification should be sent to the user to indicate the overall progress of a long running operation, such as a large file download.
333 |
# File 'lib/chef/event_dispatch/base.rb', line 333 def resource_update_progress(resource, current, total, interval); end |
#resource_updated(resource, action) ⇒ Object
Called after a resource has been completely converged, but only if modifications were made.
343 |
# File 'lib/chef/event_dispatch/base.rb', line 343 def resource_updated(resource, action); end |
#run_completed(node, run_status) ⇒ Object
Called at the end a successful Chef run.
37 |
# File 'lib/chef/event_dispatch/base.rb', line 37 def run_completed(node, run_status); end |
#run_failed(exception, run_status) ⇒ Object
Called at the end of a failed Chef run.
40 |
# File 'lib/chef/event_dispatch/base.rb', line 40 def run_failed(exception, run_status); end |
#run_list_expand_failed(node, exception) ⇒ Object
Error expanding the run list
74 |
# File 'lib/chef/event_dispatch/base.rb', line 74 def (node, exception); end |
#run_list_expanded(run_list_expansion) ⇒ Object
381 |
# File 'lib/chef/event_dispatch/base.rb', line 381 def (run_list_expansion); end |
#run_start(version, run_status) ⇒ Object
Called at the very start of a Chef Run
32 |
# File 'lib/chef/event_dispatch/base.rb', line 32 def run_start(version, run_status); end |
#run_started(run_status) ⇒ Object
34 |
# File 'lib/chef/event_dispatch/base.rb', line 34 def run_started(run_status); end |
#skipping_registration(node_name, config) ⇒ Object
Announce that we’re not going to register the client. Generally because we already have the private key, or because we’re deliberately not using a key.
49 |
# File 'lib/chef/event_dispatch/base.rb', line 49 def skipping_registration(node_name, config); end |
#stream_closed(stream, options = {}) ⇒ Object
A stream has closed.
355 |
# File 'lib/chef/event_dispatch/base.rb', line 355 def stream_closed(stream, = {}); end |
#stream_opened(stream, options = {}) ⇒ Object
A stream has opened.
352 |
# File 'lib/chef/event_dispatch/base.rb', line 352 def stream_opened(stream, = {}); end |
#stream_output(stream, output, options = {}) ⇒ Object
A chunk of data from a stream. The stream is managed by “stream,” which can be any tag whatsoever. Data in different “streams” may not be placed on the same line or even sent to the same console.
360 |
# File 'lib/chef/event_dispatch/base.rb', line 360 def stream_output(stream, output, = {}); end |
#synchronized_cookbook(cookbook_name, cookbook) ⇒ Object
Called when cookbook cookbook
has been sync’d
110 |
# File 'lib/chef/event_dispatch/base.rb', line 110 def synchronized_cookbook(cookbook_name, cookbook); end |
#updated_cookbook_file(cookbook_name, path) ⇒ Object
Called when an individual file in a cookbook has been updated
113 |
# File 'lib/chef/event_dispatch/base.rb', line 113 def updated_cookbook_file(cookbook_name, path); end |
#waivers_load_complete ⇒ Object
Called when compliance waiver loading end
201 |
# File 'lib/chef/event_dispatch/base.rb', line 201 def waivers_load_complete; end |
#waivers_load_start ⇒ Object
Called when compliance waiver loading starts
198 |
# File 'lib/chef/event_dispatch/base.rb', line 198 def waivers_load_start; end |
#whyrun_assumption(action, resource, message) ⇒ Object
Called when a provider makes an assumption after a failed assertion in whyrun mode, in order to allow execution to continue
376 |
# File 'lib/chef/event_dispatch/base.rb', line 376 def whyrun_assumption(action, resource, ); end |