Class: Chef::Application::Client

Inherits:
Chef::Application show all
Includes:
Mixin::ShellOut
Defined in:
lib/chef/application/client.rb

Constant Summary collapse

SELF_PIPE =

Mimic self_pipe sleep from Unicorn to capture signals safely

[]
IMMEDIATE_RUN_SIGNAL = 
"1".freeze

Constants included from Mixin::ShellOut

Mixin::ShellOut::DEPRECATED_OPTIONS

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Mixin::ShellOut

#run_command_compatible_options, #shell_out, #shell_out!, #shell_out_with_systems_locale, #shell_out_with_systems_locale!

Methods inherited from Chef::Application

#auto_log_level?, #configure_chef, #configure_encoding, #configure_proxy_environment_variables, #configure_stdout_logger, debug_stacktrace, exit!, fatal!, #initialize, #resolve_log_level, #run, #run_chef_client, #set_specific_recipes, #using_output_formatter?, #want_additional_logger?

Constructor Details

This class inherits a constructor from Chef::Application

Instance Attribute Details

#chef_client_json ⇒ Object (readonly)

Returns the value of attribute chef_client_json.



258
259
260
 
# File 'lib/chef/application/client.rb', line 258

def chef_client_json
  @chef_client_json
end

Instance Method Details

#configure_logging ⇒ Object 



333
334
335
336
337
 
# File 'lib/chef/application/client.rb', line 333

def configure_logging
  super
  Mixlib::Authentication::Log.use_log_devices( Chef::Log )
  Ohai::Log.use_log_devices( Chef::Log )
end

#load_config_file ⇒ Object 



322
323
324
325
326
327
328
329
330
331
 
# File 'lib/chef/application/client.rb', line 322

def load_config_file
  if !config.has_key?(:config_file) && !config[:disable_config]
    if config[:local_mode]
      config[:config_file] = Chef::WorkstationConfigLoader.new(nil, Chef::Log).config_location
    else
      config[:config_file] = Chef::Config.platform_specific_path("/etc/chef/client.rb")
    end
  end
  super
end

#reconfigure ⇒ Object

Reconfigure the chef client Re-open the JSON attributes and load them into the node

Raises:



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/chef/application/client.rb', line 262

def reconfigure
  super

  raise Chef::Exceptions::PIDFileLockfileMatch if Chef::Util::PathHelper.paths_eql? (Chef::Config[:pid_file] || '' ), (Chef::Config[:lockfile] || '')

  set_specific_recipes

  Chef::Config[:chef_server_url] = config[:chef_server_url] if config.has_key? :chef_server_url

  Chef::Config.local_mode = config[:local_mode] if config.has_key?(:local_mode)
  if Chef::Config.local_mode && !Chef::Config.has_key?(:cookbook_path) && !Chef::Config.has_key?(:chef_repo_path)
    Chef::Config.chef_repo_path = Chef::Config.find_chef_repo_path(Dir.pwd)
  end

  if !Chef::Config.local_mode && Chef::Config.has_key?(:recipe_url)
    Chef::Application.fatal!("chef-client recipe-url can be used only in local-mode", 1)
  elsif Chef::Config.local_mode && Chef::Config.has_key?(:recipe_url)
    Chef::Log.debug "Creating path #{Chef::Config.chef_repo_path} to extract recipes into"
    FileUtils.mkdir_p(Chef::Config.chef_repo_path)
    tarball_path = File.join(Chef::Config.chef_repo_path, 'recipes.tgz')
    fetch_recipe_tarball(Chef::Config[:recipe_url], tarball_path)
    result = shell_out!("tar zxvf #{tarball_path} -C #{Chef::Config.chef_repo_path}")
    Chef::Log.debug "#{result.stdout}"
  end

  Chef::Config.chef_zero.host = config[:chef_zero_host] if config[:chef_zero_host]
  Chef::Config.chef_zero.port = config[:chef_zero_port] if config[:chef_zero_port]

  if Chef::Config[:daemonize]
    Chef::Config[:interval] ||= 1800
  end

  if Chef::Config[:once]
    Chef::Config[:interval] = nil
    Chef::Config[:splay] = nil
  end

  if !Chef::Config[:client_fork] && Chef::Config[:interval] && !Chef::Platform.windows?
    Chef::Application.fatal!(unforked_interval_error_message)
  end

  if Chef::Config[:json_attribs]
    config_fetcher = Chef::ConfigFetcher.new(Chef::Config[:json_attribs])
    @chef_client_json = config_fetcher.fetch_json
  end

  if mode = config[:audit_mode] || Chef::Config[:audit_mode]
    expected_modes = [:enabled, :disabled, :audit_only]
    unless expected_modes.include?(mode)
      Chef::Application.fatal!(unrecognized_audit_mode(mode))
    end

    unless mode == :disabled
      # This should be removed when audit-mode is enabled by default/no longer
      # an experimental feature.
      Chef::Log.warn(audit_mode_experimental_message)
    end
  end
end

#run_application ⇒ Object

Run the chef client, optionally daemonizing or looping at intervals.



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/chef/application/client.rb', line 357

def run_application
  if Chef::Config[:version]
    puts "Chef version: #{::Chef::VERSION}"
  end

  if !Chef::Config[:client_fork] || Chef::Config[:once]
    begin
      # run immediately without interval sleep, or splay
      run_chef_client(Chef::Config[:specific_recipes])
    rescue SystemExit
      raise
    rescue Exception => e
      Chef::Application.fatal!("#{e.class}: #{e.message}", 1)
    end
  else
    interval_run_chef_client
  end
end

#setup_application ⇒ Object 



339
340
341
 
# File 'lib/chef/application/client.rb', line 339

def setup_application
  Chef::Daemon.change_privilege
end

#setup_signal_handlers ⇒ Object 



343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/chef/application/client.rb', line 343

def setup_signal_handlers
  super

  unless Chef::Platform.windows?
    SELF_PIPE.replace IO.pipe

    trap("USR1") do
      Chef::Log.info("SIGUSR1 received, waking up")
      SELF_PIPE[1].putc(IMMEDIATE_RUN_SIGNAL) # wakeup master process from select
    end
  end
end