1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
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
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
|
#
# Author:: AJ Christensen (<aj@opscode.com)
# Author:: Christopher Brown (<cb@opscode.com>)
# Author:: Mark Mzyk (mmzyk@opscode.com)
# Copyright:: Copyright (c) 2008 Opscode, Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'chef/application'
require 'chef/client'
require 'chef/config'
require 'chef/daemon'
require 'chef/log'
require 'chef/config_fetcher'
require 'chef/handler/error_report'
require 'chef/workstation_config_loader'
class Chef::Application::Client < Chef::Application
# Mimic self_pipe sleep from Unicorn to capture signals safely
SELF_PIPE = []
option :config_file,
:short => "-c CONFIG",
:long => "--config CONFIG",
:description => "The configuration file to use"
option :formatter,
:short => "-F FORMATTER",
:long => "--format FORMATTER",
:description => "output format to use",
:proc => lambda { |format| Chef::Config.add_formatter(format) }
option :force_logger,
:long => "--force-logger",
:description => "Use logger output instead of formatter output",
:boolean => true,
:default => false
option :force_formatter,
:long => "--force-formatter",
:description => "Use formatter output instead of logger output",
:boolean => true,
:default => false
option :color,
:long => '--[no-]color',
:boolean => true,
:default => !Chef::Platform.windows?,
:description => "Use colored output, defaults to false on Windows, true otherwise"
option :log_level,
:short => "-l LEVEL",
:long => "--log_level LEVEL",
:description => "Set the log level (debug, info, warn, error, fatal)",
:proc => lambda { |l| l.to_sym }
option :log_location,
:short => "-L LOGLOCATION",
:long => "--logfile LOGLOCATION",
:description => "Set the log file location, defaults to STDOUT - recommended for daemonizing",
:proc => nil
option :help,
:short => "-h",
:long => "--help",
:description => "Show this message",
:on => :tail,
:boolean => true,
:show_options => true,
:exit => 0
option :user,
:short => "-u USER",
:long => "--user USER",
:description => "User to set privilege to",
:proc => nil
option :group,
:short => "-g GROUP",
:long => "--group GROUP",
:description => "Group to set privilege to",
:proc => nil
unless Chef::Platform.windows?
option :daemonize,
:short => "-d",
:long => "--daemonize",
:description => "Daemonize the process",
:proc => lambda { |p| true }
end
option :pid_file,
:short => "-P PID_FILE",
:long => "--pid PIDFILE",
:description => "Set the PID file location, defaults to /tmp/chef-client.pid",
:proc => nil
option :interval,
:short => "-i SECONDS",
:long => "--interval SECONDS",
:description => "Run chef-client periodically, in seconds",
:proc => lambda { |s| s.to_i }
option :once,
:long => "--once",
:description => "Cancel any interval or splay options, run chef once and exit",
:boolean => true
option :json_attribs,
:short => "-j JSON_ATTRIBS",
:long => "--json-attributes JSON_ATTRIBS",
:description => "Load attributes from a JSON file or URL",
:proc => nil
option :node_name,
:short => "-N NODE_NAME",
:long => "--node-name NODE_NAME",
:description => "The node name for this client",
:proc => nil
option :splay,
:short => "-s SECONDS",
:long => "--splay SECONDS",
:description => "The splay time for running at intervals, in seconds",
:proc => lambda { |s| s.to_i }
option :chef_server_url,
:short => "-S CHEFSERVERURL",
:long => "--server CHEFSERVERURL",
:description => "The chef server URL",
:proc => nil
option :validation_key,
:short => "-K KEY_FILE",
:long => "--validation_key KEY_FILE",
:description => "Set the validation key file location, used for registering new clients",
:proc => nil
option :client_key,
:short => "-k KEY_FILE",
:long => "--client_key KEY_FILE",
:description => "Set the client key file location",
:proc => nil
option :environment,
:short => '-E ENVIRONMENT',
:long => '--environment ENVIRONMENT',
:description => 'Set the Chef Environment on the node'
option :version,
:short => "-v",
:long => "--version",
:description => "Show chef version",
:boolean => true,
:proc => lambda {|v| puts "Chef: #{::Chef::VERSION}"},
:exit => 0
option :override_runlist,
:short => "-o RunlistItem,RunlistItem...",
:long => "--override-runlist RunlistItem,RunlistItem...",
:description => "Replace current run list with specified items for a single run",
:proc => lambda{|items|
items = items.split(',')
items.compact.map{|item|
Chef::RunList::RunListItem.new(item)
}
}
option :runlist,
:short => "-r RunlistItem,RunlistItem...",
:long => "--runlist RunlistItem,RunlistItem...",
:description => "Permanently replace current run list with specified items",
:proc => lambda{|items|
items = items.split(',')
items.compact.map{|item|
Chef::RunList::RunListItem.new(item)
}
}
option :why_run,
:short => '-W',
:long => '--why-run',
:description => 'Enable whyrun mode',
:boolean => true
option :client_fork,
:short => "-f",
:long => "--[no-]fork",
:description => "Fork client",
:boolean => true
option :enable_reporting,
:short => "-R",
:long => "--enable-reporting",
:description => "Enable reporting data collection for chef runs",
:boolean => true
option :local_mode,
:short => "-z",
:long => "--local-mode",
:description => "Point chef-client at local repository",
:boolean => true
option :chef_zero_host,
:long => "--chef-zero-host HOST",
:description => "Host to start chef-zero on"
option :chef_zero_port,
:long => "--chef-zero-port PORT",
:description => "Port (or port range) to start chef-zero on. Port ranges like 1000,1010 or 8889-9999 will try all given ports until one works."
option :dont_load_config,
:long => "--dont-load-config",
:description => "Refuse to load a config file and use defaults. This is for development and not a stable API",
:boolean => true
option :run_lock_timeout,
:long => "--run-lock-timeout SECONDS",
:description => "Set maximum duration to wait for another client run to finish, default is indefinitely.",
:proc => lambda { |s| s.to_i }
if Chef::Platform.windows?
option :fatal_windows_admin_check,
:short => "-A",
:long => "--fatal-windows-admin-check",
:description => "Fail the run when chef-client doesn't have administrator privileges on Windows",
:boolean => true
end
IMMEDIATE_RUN_SIGNAL = "1".freeze
GRACEFUL_EXIT_SIGNAL = "2".freeze
attr_reader :chef_client_json
# Reconfigure the chef client
# Re-open the JSON attributes and load them into the node
def reconfigure
super
Chef::Config[:specific_recipes] = cli_arguments.map { |file| File.expand_path(file) }
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
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[:json_attribs]
config_fetcher = Chef::ConfigFetcher.new(Chef::Config[:json_attribs])
@chef_client_json = config_fetcher.fetch_json
end
end
def load_config_file
if !config.has_key?(:config_file) && !config[:dont_load_config]
if config[:local_mode]
config[:config_file] = Chef::WorkstationConfigLoader.new(nil).config_location
else
config[:config_file] = Chef::Config.platform_specific_path("/etc/chef/client.rb")
end
end
super
end
def configure_logging
super
Mixlib::Authentication::Log.use_log_devices( Chef::Log )
Ohai::Log.use_log_devices( Chef::Log )
end
def setup_application
Chef::Daemon.change_privilege
end
# Run the chef client, optionally daemonizing or looping at intervals.
def run_application
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
# see CHEF-5172
if Chef::Config[:daemonize] || Chef::Config[:interval]
trap("TERM") do
Chef::Log.info("SIGTERM received, exiting gracefully")
SELF_PIPE[1].putc(GRACEFUL_EXIT_SIGNAL)
end
end
end
if Chef::Config[:version]
puts "Chef version: #{::Chef::VERSION}"
end
if Chef::Config[:daemonize]
Chef::Daemon.daemonize("chef-client")
end
signal = nil
loop do
begin
Chef::Application.exit!("Exiting", 0) if signal == GRACEFUL_EXIT_SIGNAL
if Chef::Config[:splay] and signal != IMMEDIATE_RUN_SIGNAL
splay = rand Chef::Config[:splay]
Chef::Log.debug("Splay sleep #{splay} seconds")
sleep splay
end
signal = nil
run_chef_client(Chef::Config[:specific_recipes])
if Chef::Config[:interval]
Chef::Log.debug("Sleeping for #{Chef::Config[:interval]} seconds")
signal = interval_sleep
else
Chef::Application.exit! "Exiting", 0
end
rescue SystemExit => e
raise
rescue Exception => e
if Chef::Config[:interval]
Chef::Log.error("#{e.class}: #{e}")
Chef::Log.error("Sleeping for #{Chef::Config[:interval]} seconds before trying again")
signal = interval_sleep
retry
else
Chef::Application.fatal!("#{e.class}: #{e.message}", 1)
end
end
end
end
private
def interval_sleep
unless SELF_PIPE.empty?
client_sleep Chef::Config[:interval]
else
# Windows
sleep Chef::Config[:interval]
end
end
def client_sleep(sec)
IO.select([ SELF_PIPE[0] ], nil, nil, sec) or return
SELF_PIPE[0].getc.chr
end
end
|