Class: Chef::Knife
- Inherits:
-
Object
show all
- Extended by:
- Mixin::ConvertToClassName, Forwardable
- Includes:
- Mixin::PathSanity, Mixlib::CLI
- Defined in:
- lib/chef/knife.rb,
lib/chef/knife/raw.rb,
lib/chef/knife/ssh.rb,
lib/chef/knife/deps.rb,
lib/chef/knife/diff.rb,
lib/chef/knife/edit.rb,
lib/chef/knife/help.rb,
lib/chef/knife/list.rb,
lib/chef/knife/null.rb,
lib/chef/knife/show.rb,
lib/chef/knife/serve.rb,
lib/chef/knife/xargs.rb,
lib/chef/knife/delete.rb,
lib/chef/knife/rehash.rb,
lib/chef/knife/search.rb,
lib/chef/knife/status.rb,
lib/chef/knife/upload.rb,
lib/chef/knife/core/ui.rb,
lib/chef/knife/download.rb,
lib/chef/knife/key_edit.rb,
lib/chef/knife/key_list.rb,
lib/chef/knife/key_show.rb,
lib/chef/knife/tag_list.rb,
lib/chef/knife/bootstrap.rb,
lib/chef/knife/configure.rb,
lib/chef/knife/node_edit.rb,
lib/chef/knife/node_list.rb,
lib/chef/knife/node_show.rb,
lib/chef/knife/role_edit.rb,
lib/chef/knife/role_list.rb,
lib/chef/knife/role_show.rb,
lib/chef/knife/ssl_check.rb,
lib/chef/knife/ssl_fetch.rb,
lib/chef/knife/user_edit.rb,
lib/chef/knife/user_list.rb,
lib/chef/knife/user_show.rb,
lib/chef/knife/key_create.rb,
lib/chef/knife/key_delete.rb,
lib/chef/knife/tag_create.rb,
lib/chef/knife/tag_delete.rb,
lib/chef/knife/client_edit.rb,
lib/chef/knife/client_list.rb,
lib/chef/knife/client_show.rb,
lib/chef/knife/node_create.rb,
lib/chef/knife/node_delete.rb,
lib/chef/knife/role_create.rb,
lib/chef/knife/role_delete.rb,
lib/chef/knife/user_create.rb,
lib/chef/knife/user_delete.rb,
lib/chef/knife/client_create.rb,
lib/chef/knife/client_delete.rb,
lib/chef/knife/cookbook_list.rb,
lib/chef/knife/cookbook_show.rb,
lib/chef/knife/cookbook_test.rb,
lib/chef/knife/data_bag_edit.rb,
lib/chef/knife/data_bag_list.rb,
lib/chef/knife/data_bag_show.rb,
lib/chef/knife/index_rebuild.rb,
lib/chef/knife/key_edit_base.rb,
lib/chef/knife/key_list_base.rb,
lib/chef/knife/osc_user_edit.rb,
lib/chef/knife/osc_user_list.rb,
lib/chef/knife/osc_user_show.rb,
lib/chef/knife/user_key_edit.rb,
lib/chef/knife/user_key_list.rb,
lib/chef/knife/user_key_show.rb,
lib/chef/knife/node_from_file.rb,
lib/chef/knife/role_from_file.rb,
lib/chef/knife/client_key_edit.rb,
lib/chef/knife/client_key_list.rb,
lib/chef/knife/client_key_show.rb,
lib/chef/knife/cookbook_create.rb,
lib/chef/knife/cookbook_delete.rb,
lib/chef/knife/cookbook_upload.rb,
lib/chef/knife/data_bag_create.rb,
lib/chef/knife/data_bag_delete.rb,
lib/chef/knife/key_create_base.rb,
lib/chef/knife/osc_user_create.rb,
lib/chef/knife/osc_user_delete.rb,
lib/chef/knife/user_key_create.rb,
lib/chef/knife/user_key_delete.rb,
lib/chef/knife/user_reregister.rb,
lib/chef/knife/configure_client.rb,
lib/chef/knife/core/node_editor.rb,
lib/chef/knife/environment_edit.rb,
lib/chef/knife/environment_list.rb,
lib/chef/knife/environment_show.rb,
lib/chef/knife/node_bulk_delete.rb,
lib/chef/knife/role_bulk_delete.rb,
lib/chef/knife/supermarket_list.rb,
lib/chef/knife/supermarket_show.rb,
lib/chef/knife/client_key_create.rb,
lib/chef/knife/client_key_delete.rb,
lib/chef/knife/client_reregister.rb,
lib/chef/knife/cookbook_download.rb,
lib/chef/knife/cookbook_metadata.rb,
lib/chef/knife/node_run_list_add.rb,
lib/chef/knife/node_run_list_set.rb,
lib/chef/knife/role_run_list_add.rb,
lib/chef/knife/role_run_list_set.rb,
lib/chef/knife/supermarket_share.rb,
lib/chef/knife/client_bulk_delete.rb,
lib/chef/knife/cookbook_site_list.rb,
lib/chef/knife/cookbook_site_show.rb,
lib/chef/knife/core/object_loader.rb,
lib/chef/knife/data_bag_from_file.rb,
lib/chef/knife/environment_create.rb,
lib/chef/knife/environment_delete.rb,
lib/chef/knife/supermarket_search.rb,
lib/chef/knife/cookbook_site_share.rb,
lib/chef/knife/core/node_presenter.rb,
lib/chef/knife/core/text_formatter.rb,
lib/chef/knife/environment_compare.rb,
lib/chef/knife/osc_user_reregister.rb,
lib/chef/knife/role_run_list_clear.rb,
lib/chef/knife/supermarket_install.rb,
lib/chef/knife/supermarket_unshare.rb,
lib/chef/knife/cookbook_bulk_delete.rb,
lib/chef/knife/cookbook_site_search.rb,
lib/chef/knife/core/gem_glob_loader.rb,
lib/chef/knife/node_environment_set.rb,
lib/chef/knife/node_run_list_remove.rb,
lib/chef/knife/role_run_list_remove.rb,
lib/chef/knife/supermarket_download.rb,
lib/chef/knife/cookbook_site_install.rb,
lib/chef/knife/cookbook_site_unshare.rb,
lib/chef/knife/core/status_presenter.rb,
lib/chef/knife/environment_from_file.rb,
lib/chef/knife/role_env_run_list_add.rb,
lib/chef/knife/role_env_run_list_set.rb,
lib/chef/knife/role_run_list_replace.rb,
lib/chef/knife/cookbook_site_download.rb,
lib/chef/knife/core/bootstrap_context.rb,
lib/chef/knife/core/cookbook_scm_repo.rb,
lib/chef/knife/core/generic_presenter.rb,
lib/chef/knife/core/subcommand_loader.rb,
lib/chef/knife/data_bag_secret_options.rb,
lib/chef/knife/role_env_run_list_clear.rb,
lib/chef/knife/bootstrap/client_builder.rb,
lib/chef/knife/role_env_run_list_remove.rb,
lib/chef/knife/role_env_run_list_replace.rb,
lib/chef/knife/core/hashed_command_loader.rb,
lib/chef/knife/cookbook_metadata_from_file.rb,
lib/chef/knife/core/custom_manifest_loader.rb,
lib/chef/knife/bootstrap/chef_vault_handler.rb
Direct Known Subclasses
ChefFS::Knife, Bootstrap, ClientBulkDelete, ClientCreate, ClientDelete, ClientEdit, ClientKeyCreate, ClientKeyDelete, ClientKeyEdit, ClientKeyList, ClientKeyShow, ClientList, ClientReregister, ClientShow, Configure, ConfigureClient, CookbookBulkDelete, CookbookCreate, CookbookDelete, CookbookDownload, CookbookList, CookbookMetadata, CookbookMetadataFromFile, CookbookShow, CookbookSiteDownload, CookbookSiteInstall, CookbookSiteList, CookbookSiteSearch, CookbookSiteShare, CookbookSiteShow, CookbookSiteUnshare, CookbookTest, CookbookUpload, DataBagCreate, DataBagDelete, DataBagEdit, DataBagFromFile, DataBagList, DataBagShow, EnvironmentCompare, EnvironmentCreate, EnvironmentDelete, EnvironmentEdit, EnvironmentFromFile, EnvironmentList, EnvironmentShow, Exec, Help, IndexRebuild, NodeBulkDelete, NodeCreate, NodeDelete, NodeEdit, NodeEnvironmentSet, NodeFromFile, NodeList, NodeRunListAdd, NodeRunListRemove, NodeRunListSet, NodeShow, Null, OscUserCreate, OscUserDelete, OscUserEdit, OscUserList, OscUserReregister, OscUserShow, Raw, RecipeList, Rehash, RoleBulkDelete, RoleCreate, RoleDelete, RoleEdit, RoleEnvRunListAdd, RoleEnvRunListClear, RoleEnvRunListRemove, RoleEnvRunListReplace, RoleEnvRunListSet, RoleFromFile, RoleList, RoleRunListAdd, RoleRunListClear, RoleRunListRemove, RoleRunListReplace, RoleRunListSet, RoleShow, Search, Serve, Ssh, SslCheck, SslFetch, Status, TagCreate, TagDelete, TagList, UserCreate, UserDelete, UserEdit, UserKeyCreate, UserKeyDelete, UserKeyEdit, UserKeyList, UserKeyShow, UserList, UserReregister, UserShow
Defined Under Namespace
Modules: Core, DataBagSecretOptions, KeyCreateBase, KeyEditBase, KeyListBase
Classes: Bootstrap, ClientBulkDelete, ClientCreate, ClientDelete, ClientEdit, ClientKeyCreate, ClientKeyDelete, ClientKeyEdit, ClientKeyList, ClientKeyShow, ClientList, ClientReregister, ClientShow, Configure, ConfigureClient, CookbookBulkDelete, CookbookCreate, CookbookDelete, CookbookDownload, CookbookList, CookbookMetadata, CookbookMetadataFromFile, CookbookSCMRepo, CookbookShow, CookbookSiteDownload, CookbookSiteInstall, CookbookSiteList, CookbookSiteSearch, CookbookSiteShare, CookbookSiteShow, CookbookSiteUnshare, CookbookSiteVendor, CookbookTest, CookbookUpload, DataBagCreate, DataBagDelete, DataBagEdit, DataBagFromFile, DataBagList, DataBagShow, Delete, Deps, Diff, Download, Edit, EnvironmentCompare, EnvironmentCreate, EnvironmentDelete, EnvironmentEdit, EnvironmentFromFile, EnvironmentList, EnvironmentShow, Exec, Help, IndexRebuild, KeyCreate, KeyDelete, KeyEdit, KeyList, KeyShow, List, NodeBulkDelete, NodeCreate, NodeDelete, NodeEdit, NodeEditor, NodeEnvironmentSet, NodeFromFile, NodeList, NodeRunListAdd, NodeRunListRemove, NodeRunListSet, NodeShow, Null, OscUserCreate, OscUserDelete, OscUserEdit, OscUserList, OscUserReregister, OscUserShow, Raw, RecipeList, Rehash, RoleBulkDelete, RoleCreate, RoleDelete, RoleEdit, RoleEnvRunListAdd, RoleEnvRunListClear, RoleEnvRunListRemove, RoleEnvRunListReplace, RoleEnvRunListSet, RoleFromFile, RoleList, RoleRunListAdd, RoleRunListClear, RoleRunListRemove, RoleRunListReplace, RoleRunListSet, RoleShow, Search, Serve, Show, Ssh, SslCheck, SslFetch, Status, SubcommandLoader, SupermarketDownload, SupermarketInstall, SupermarketList, SupermarketSearch, SupermarketShare, SupermarketShow, SupermarketUnshare, TagCreate, TagDelete, TagList, UI, Upload, UserCreate, UserDelete, UserEdit, UserKeyCreate, UserKeyDelete, UserKeyEdit, UserKeyList, UserKeyShow, UserList, UserReregister, UserShow, Xargs
Constant Summary
collapse
- @@chef_config_dir =
nil
Instance Attribute Summary collapse
Class Method Summary
collapse
Instance Method Summary
collapse
constantize, convert_to_class_name, convert_to_snake_case, filename_to_qualified_string, normalize_snake_case_name, snake_case_basename
#enforce_path_sanity
Constructor Details
#initialize(argv = []) ⇒ Knife
Create a new instance of the current class configured for the given arguments and options
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
|
# File 'lib/chef/knife.rb', line 293
def initialize(argv = [])
super() @ui = Chef::Knife::UI.new(STDOUT, STDERR, STDIN, config)
command_name_words = self.class.snake_case_name.split("_")
@name_args = parse_options(argv)
@name_args.delete(command_name_words.join("-"))
@name_args.reject! { |name_arg| command_name_words.delete(name_arg) }
command_name_words = command_name_words.join("_")
@name_args.reject! { |name_arg| command_name_words == name_arg }
if config[:help]
msg opt_parser
exit 1
end
Chef::Config[:verbosity] = config[:verbosity] if config[:verbosity]
end
|
Instance Attribute Details
#name_args ⇒ Object
Returns the value of attribute name_args.
63
64
65
|
# File 'lib/chef/knife.rb', line 63
def name_args
@name_args
end
|
#ui ⇒ Object
Returns the value of attribute ui.
64
65
66
|
# File 'lib/chef/knife.rb', line 64
def ui
@ui
end
|
Class Method Details
.category(new_category) ⇒ Object
Explicitly set the category for the current command to new_category
The category is normally determined from the first word of the command name, but some commands make more sense using two or more words
Arguments
- new_category:
-
A String to set the category to (see examples)
Examples:
Data bag commands would be in the ‘data’ category by default. To put them in the ‘data bag’ category:
category('data bag')
114
115
116
|
# File 'lib/chef/knife.rb', line 114
def self.category(new_category)
@category = new_category
end
|
.chef_config_dir ⇒ Object
193
194
195
|
# File 'lib/chef/knife.rb', line 193
def self.chef_config_dir
@@chef_config_dir ||= config_loader.chef_config_dir
end
|
.common_name ⇒ Object
126
127
128
|
# File 'lib/chef/knife.rb', line 126
def self.common_name
snake_case_name.split("_").join(" ")
end
|
.dependency_loaders ⇒ Object
222
223
224
|
# File 'lib/chef/knife.rb', line 222
def self.dependency_loaders
@dependency_loaders ||= []
end
|
.deps(&block) ⇒ Object
226
227
228
|
# File 'lib/chef/knife.rb', line 226
def self.deps(&block)
dependency_loaders << block
end
|
.guess_category(args) ⇒ Object
143
144
145
|
# File 'lib/chef/knife.rb', line 143
def self.guess_category(args)
subcommand_loader.guess_category(args)
end
|
.inherited(subclass) ⇒ Object
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
# File 'lib/chef/knife.rb', line 89
def self.inherited(subclass)
unless subclass.unnamed?
subcommands[subclass.snake_case_name] = subclass
subcommand_files[subclass.snake_case_name] +=
if subclass.superclass.to_s == "Chef::ChefFS::Knife"
[path_from_caller(caller[1])]
else
[path_from_caller(caller[0])]
end
end
end
|
.load_commands ⇒ Object
139
140
141
|
# File 'lib/chef/knife.rb', line 139
def self.load_commands
@commands_loaded ||= subcommand_loader.load_commands
end
|
.load_config(explicit_config_file) ⇒ Object
181
182
183
184
185
186
187
188
189
190
191
|
# File 'lib/chef/knife.rb', line 181
def self.load_config(explicit_config_file)
config_loader.explicit_config_file = explicit_config_file
config_loader.load
ui.warn("No knife configuration file found") if config_loader.no_config_found?
config_loader
rescue Exceptions::ConfigurationError => e
ui.error(ui.color("CONFIGURATION ERROR:", :red) + e.message)
exit 1
end
|
.load_deps ⇒ Object
230
231
232
233
234
|
# File 'lib/chef/knife.rb', line 230
def self.load_deps
dependency_loaders.each do |dep_loader|
dep_loader.call
end
end
|
.msg(msg = "") ⇒ Object
75
76
77
|
# File 'lib/chef/knife.rb', line 75
def self.msg(msg = "")
ui.msg(msg)
end
|
.reset_config_loader! ⇒ Object
79
80
81
82
|
# File 'lib/chef/knife.rb', line 79
def self.reset_config_loader!
@@chef_config_dir = nil
@config_loader = nil
end
|
.reset_subcommands! ⇒ Object
84
85
86
87
|
# File 'lib/chef/knife.rb', line 84
def self.reset_subcommands!
@@subcommands = {}
@subcommands_by_category = nil
end
|
.run(args, options = {}) ⇒ Object
Run knife for the given args
(ARGV), adding options
to the list of CLI options that the subcommand knows how to handle.
Arguments
- args:
-
usually ARGV
- options:
-
A Mixlib::CLI option parser hash. These options
are how
subcommands know about global knife CLI options
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
# File 'lib/chef/knife.rb', line 203
def self.run(args, options = {})
if ENV["KNIFE_DEBUG"]
Chef::Log.init($stderr)
Chef::Log.level(:debug)
end
subcommand_class = subcommand_class_from(args)
subcommand_class.options = options.merge!(subcommand_class.options)
subcommand_class.load_deps
instance = subcommand_class.new(args)
instance.configure_chef
instance.run_with_pretty_exceptions
end
|
.snake_case_name ⇒ Object
122
123
124
|
# File 'lib/chef/knife.rb', line 122
def self.snake_case_name
convert_to_snake_case(name.split("::").last) unless unnamed?
end
|
.subcommand_category ⇒ Object
118
119
120
|
# File 'lib/chef/knife.rb', line 118
def self.subcommand_category
@category || snake_case_name.split("_").first unless unnamed?
end
|
.subcommand_class_from(args) ⇒ Object
147
148
149
150
151
152
153
154
|
# File 'lib/chef/knife.rb', line 147
def self.subcommand_class_from(args)
if args.size == 1 && args[0].strip.casecmp("rehash").zero?
@subcommand_loader = Chef::Knife::SubcommandLoader.gem_glob_loader(chef_config_dir)
end
subcommand_loader.command_class_from(args) || subcommand_not_found!(args)
end
|
.subcommand_files ⇒ Object
160
161
162
|
# File 'lib/chef/knife.rb', line 160
def self.subcommand_files
@@subcommand_files ||= Hash.new([])
end
|
.subcommand_loader ⇒ Object
.subcommands ⇒ Object
156
157
158
|
# File 'lib/chef/knife.rb', line 156
def self.subcommands
@@subcommands ||= {}
end
|
.subcommands_by_category ⇒ Object
164
165
166
167
168
169
170
171
172
|
# File 'lib/chef/knife.rb', line 164
def self.subcommands_by_category
unless @subcommands_by_category
@subcommands_by_category = Hash.new { |hash, key| hash[key] = [] }
subcommands.each do |snake_cased, klass|
@subcommands_by_category[klass.subcommand_category] << snake_cased
end
end
@subcommands_by_category
end
|
.ui ⇒ Object
71
72
73
|
# File 'lib/chef/knife.rb', line 71
def self.ui
@ui ||= Chef::Knife::UI.new(STDOUT, STDERR, STDIN, {})
end
|
.unnamed? ⇒ Boolean
Does this class have a name? (Classes created via Class.new don’t)
131
132
133
|
# File 'lib/chef/knife.rb', line 131
def self.unnamed?
name.nil? || name.empty?
end
|
.use_separate_defaults? ⇒ Boolean
Configure mixlib-cli to always separate defaults from user-supplied CLI options
67
68
69
|
# File 'lib/chef/knife.rb', line 67
def self.use_separate_defaults?
true
end
|
Instance Method Details
#api_key ⇒ Object
504
505
506
|
# File 'lib/chef/knife.rb', line 504
def api_key
Chef::Config[:client_key]
end
|
#apply_computed_config ⇒ Object
Catch-all method that does any massaging needed for various config components, such as expanding file paths and converting verbosity level into log level.
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
|
# File 'lib/chef/knife.rb', line 357
def apply_computed_config
Chef::Config[:color] = config[:color]
case Chef::Config[:verbosity]
when 0, nil
Chef::Config[:log_level] = :warn
when 1
Chef::Config[:log_level] = :info
else
Chef::Config[:log_level] = :debug
end
Chef::Config[:log_level] = :debug if ENV["KNIFE_DEBUG"]
Chef::Config[:node_name] = config[:node_name] if config[:node_name]
Chef::Config[:client_key] = config[:client_key] if config[:client_key]
Chef::Config[:chef_server_url] = config[:chef_server_url] if config[:chef_server_url]
Chef::Config[:environment] = config[:environment] if config[:environment]
Chef::Config.local_mode = config[:local_mode] if config.has_key?(:local_mode)
Chef::Config.listen = config[:listen] if config.has_key?(:listen)
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[:client_key] && config[:config_file]
Chef::Config[:client_key] = File.expand_path(Chef::Config[:client_key], File.dirname(config[:config_file]))
end
Mixlib::Log::Formatter.show_time = false
Chef::Log.init(Chef::Config[:log_location])
Chef::Log.level(Chef::Config[:log_level] || :error)
end
|
#config_file_settings ⇒ Object
Returns a subset of the Chef::Config Hash that is relevant to the currently executing knife command. This is used by #configure_chef to apply settings from knife.rb to the config
hash.
330
331
332
333
334
335
336
|
# File 'lib/chef/knife.rb', line 330
def config_file_settings
config_file_settings = {}
self.class.options.keys.each do |key|
config_file_settings[key] = Chef::Config[:knife][key] if Chef::Config[:knife].has_key?(key)
end
config_file_settings
end
|
397
398
399
400
401
402
403
404
405
406
407
408
|
# File 'lib/chef/knife.rb', line 397
def configure_chef
Chef::Config[:log_location] = STDERR
config_loader = self.class.load_config(config[:config_file])
config[:config_file] = config_loader.config_location
merge_configs
apply_computed_config
Chef::Config.export_proxies
Chef::Log.info("Using configuration from #{config[:config_file]}") if config[:config_file]
end
|
#create_object(object, pretty_name = nil, object_class: nil) ⇒ Object
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
|
# File 'lib/chef/knife.rb', line 519
def create_object(object, pretty_name = nil, object_class: nil)
output = edit_data(object, object_class: object_class)
if Kernel.block_given?
output = yield(output)
else
output.save
end
pretty_name ||= output
self.msg("Created #{pretty_name}")
output(output) if config[:print_after]
end
|
#delete_object(klass, name, delete_name = nil) ⇒ Object
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
|
# File 'lib/chef/knife.rb', line 536
def delete_object(klass, name, delete_name = nil)
confirm("Do you really want to delete #{name}")
if Kernel.block_given?
object = yield
else
object = klass.load(name)
object.destroy
end
output(format_for_display(object)) if config[:print_after]
obj_name = delete_name ? "#{delete_name}[#{name}]" : object
self.msg("Deleted #{obj_name}")
end
|
Parses JSON from the error response sent by Chef Server and returns the error message – TODO: this code belongs in Chef::REST
512
513
514
515
516
|
# File 'lib/chef/knife.rb', line 512
def format_rest_error(response)
Array(Chef::JSONCompat.from_json(response.body)["error"]).join("; ")
rescue Exception
response.body
end
|
#humanize_exception(e) ⇒ Object
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
|
# File 'lib/chef/knife.rb', line 429
def humanize_exception(e)
case e
when SystemExit
raise when Net::HTTPServerException, Net::HTTPFatalError
humanize_http_exception(e)
when OpenSSL::SSL::SSLError
ui.error "Could not establish a secure connection to the server."
ui.info "Use `knife ssl check` to troubleshoot your SSL configuration."
ui.info "If your Chef Server uses a self-signed certificate, you can use"
ui.info "`knife ssl fetch` to make knife trust the server's certificates."
ui.info ""
ui.info "Original Exception: #{e.class.name}: #{e.message}"
when Errno::ECONNREFUSED, Timeout::Error, Errno::ETIMEDOUT, SocketError
ui.error "Network Error: #{e.message}"
ui.info "Check your knife configuration and network settings"
when NameError, NoMethodError
ui.error "knife encountered an unexpected error"
ui.info "This may be a bug in the '#{self.class.common_name}' knife command or plugin"
ui.info "Please collect the output of this command with the `-VV` option before filing a bug report."
ui.info "Exception: #{e.class.name}: #{e.message}"
when Chef::Exceptions::PrivateKeyMissing
ui.error "Your private key could not be loaded from #{api_key}"
ui.info "Check your configuration file and ensure that your private key is readable"
when Chef::Exceptions::InvalidRedirect
ui.error "Invalid Redirect: #{e.message}"
ui.info "Change your server location in knife.rb to the server's FQDN to avoid unwanted redirections."
else
ui.error "#{e.class.name}: #{e.message}"
end
end
|
#humanize_http_exception(e) ⇒ Object
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
|
# File 'lib/chef/knife.rb', line 461
def humanize_http_exception(e)
response = e.response
case response
when Net::HTTPUnauthorized
ui.error "Failed to authenticate to #{server_url} as #{username} with key #{api_key}"
ui.info "Response: #{format_rest_error(response)}"
when Net::HTTPForbidden
ui.error "You authenticated successfully to #{server_url} as #{username} but you are not authorized for this action"
ui.info "Response: #{format_rest_error(response)}"
when Net::HTTPBadRequest
ui.error "The data in your request was invalid"
ui.info "Response: #{format_rest_error(response)}"
when Net::HTTPNotFound
ui.error "The object you are looking for could not be found"
ui.info "Response: #{format_rest_error(response)}"
when Net::HTTPInternalServerError
ui.error "internal server error"
ui.info "Response: #{format_rest_error(response)}"
when Net::HTTPBadGateway
ui.error "bad gateway"
ui.info "Response: #{format_rest_error(response)}"
when Net::HTTPServiceUnavailable
ui.error "Service temporarily unavailable"
ui.info "Response: #{format_rest_error(response)}"
when Net::HTTPNotAcceptable
= Chef::JSONCompat.from_json(response["x-ops-server-api-version"])
client_api_version = ["request_version"]
min_server_version = ["min_version"]
max_server_version = ["max_version"]
ui.error "The version of Chef that Knife is using is not supported by the Chef server you sent this request to"
ui.info "The request that Knife sent was using API version #{client_api_version}"
ui.info "The Chef server you sent the request to supports a min API verson of #{min_server_version} and a max API version of #{max_server_version}"
ui.info "Please either update your Chef client or server to be a compatible set"
else
ui.error response.message
ui.info "Response: #{format_rest_error(response)}"
end
end
|
#maybe_setup_fips ⇒ Object
580
581
582
583
584
585
|
# File 'lib/chef/knife.rb', line 580
def maybe_setup_fips
if !config[:fips].nil?
Chef::Config[:fips] = config[:fips]
end
Chef::Config.init_openssl
end
|
#merge_configs ⇒ Object
Apply Config in this order: defaults from mixlib-cli settings from config file, via Chef::Config config from command line
342
343
344
345
346
347
348
349
350
351
352
|
# File 'lib/chef/knife.rb', line 342
def merge_configs
combined_config = default_config.merge(config_file_settings)
combined_config = combined_config.merge(config)
config.replace(combined_config)
end
|
#noauth_rest ⇒ Object
569
570
571
572
573
574
|
# File 'lib/chef/knife.rb', line 569
def noauth_rest
@rest ||= begin
require "chef/http/simple_json"
Chef::HTTP::SimpleJSON.new(Chef::Config[:chef_server_url])
end
end
|
#parse_options(args) ⇒ Object
319
320
321
322
323
324
325
|
# File 'lib/chef/knife.rb', line 319
def parse_options(args)
super
rescue OptionParser::InvalidOption => e
puts "Error: " + e.to_s
show_usage
exit(1)
end
|
#rest ⇒ Object
562
563
564
565
566
567
|
# File 'lib/chef/knife.rb', line 562
def rest
@rest ||= begin
require "chef/server_api"
Chef::ServerAPI.new(Chef::Config[:chef_server_url])
end
end
|
#run_with_pretty_exceptions(raise_exception = false) ⇒ Object
414
415
416
417
418
419
420
421
422
423
424
425
426
427
|
# File 'lib/chef/knife.rb', line 414
def run_with_pretty_exceptions(raise_exception = false)
unless self.respond_to?(:run)
ui.error "You need to add a #run method to your knife command before you can use it"
end
enforce_path_sanity
maybe_setup_fips
Chef::LocalMode.with_server_connectivity do
run
end
rescue Exception => e
raise if raise_exception || Chef::Config[:verbosity] == 2
humanize_exception(e)
exit 100
end
|
#server_url ⇒ Object
576
577
578
|
# File 'lib/chef/knife.rb', line 576
def server_url
Chef::Config[:chef_server_url]
end
|
#show_usage ⇒ Object
410
411
412
|
# File 'lib/chef/knife.rb', line 410
def show_usage
stdout.puts("USAGE: " + self.opt_parser.to_s)
end
|
#test_mandatory_field(field, fieldname) ⇒ Object
helper method for testing if a field exists and returning the usage and proper error if not
554
555
556
557
558
559
560
|
# File 'lib/chef/knife.rb', line 554
def test_mandatory_field(field, fieldname)
if field.nil?
show_usage
ui.fatal("You must specify a #{fieldname}")
exit 1
end
end
|
#username ⇒ Object
500
501
502
|
# File 'lib/chef/knife.rb', line 500
def username
Chef::Config[:node_name]
end
|