Class: Chef::Knife::Configure

Inherits:
Chef::Knife show all
Defined in:
lib/chef/knife/configure.rb

Constant Summary

Constants inherited from Chef::Knife

OFFICIAL_PLUGINS

Instance Attribute Summary collapse

Attributes inherited from Chef::Knife

#name_args, #ui

Instance Method Summary collapse

Methods inherited from Chef::Knife

#api_key, #apply_computed_config, category, chef_config_dir, #cli_keys, common_name, #config_file_settings, config_loader, #create_object, #delete_object, dependency_loaders, deps, #format_rest_error, guess_category, #humanize_exception, #humanize_http_exception, inherited, #initialize, list_commands, load_commands, load_config, load_deps, #maybe_setup_fips, #merge_configs, msg, #noauth_rest, #parse_options, reset_config_loader!, reset_subcommands!, #rest, run, #run_with_pretty_exceptions, #server_url, #show_usage, snake_case_name, subcommand_category, subcommand_class_from, subcommand_files, subcommand_loader, subcommands, subcommands_by_category, #test_mandatory_field, ui, unnamed?, use_separate_defaults?, #username

Methods included from Mixin::ConvertToClassName

#constantize, #convert_to_class_name, #convert_to_snake_case, #filename_to_qualified_string, #normalize_snake_case_name, #snake_case_basename

Methods included from Mixin::PathSanity

#enforce_path_sanity, #sanitized_path

Constructor Details

This class inherits a constructor from Chef::Knife

Instance Attribute Details

#admin_client_keyObject (readonly)

Returns the value of attribute admin_client_key


24
25
26
# File 'lib/chef/knife/configure.rb', line 24

def admin_client_key
  @admin_client_key
end

#admin_client_nameObject (readonly)

Returns the value of attribute admin_client_name


24
25
26
# File 'lib/chef/knife/configure.rb', line 24

def admin_client_name
  @admin_client_name
end

#chef_repoObject (readonly)

Returns the value of attribute chef_repo


25
26
27
# File 'lib/chef/knife/configure.rb', line 25

def chef_repo
  @chef_repo
end

#chef_serverObject (readonly)

Returns the value of attribute chef_server


24
25
26
# File 'lib/chef/knife/configure.rb', line 24

def chef_server
  @chef_server
end

#new_client_keyObject (readonly)

Returns the value of attribute new_client_key


25
26
27
# File 'lib/chef/knife/configure.rb', line 25

def new_client_key
  @new_client_key
end

#new_client_nameObject (readonly)

Returns the value of attribute new_client_name


24
25
26
# File 'lib/chef/knife/configure.rb', line 24

def new_client_name
  @new_client_name
end

#validation_client_nameObject (readonly)

Returns the value of attribute validation_client_name


25
26
27
# File 'lib/chef/knife/configure.rb', line 25

def validation_client_name
  @validation_client_name
end

#validation_keyObject (readonly)

Returns the value of attribute validation_key


25
26
27
# File 'lib/chef/knife/configure.rb', line 25

def validation_key
  @validation_key
end

Instance Method Details

#ask_user_for_configObject


132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
# File 'lib/chef/knife/configure.rb', line 132

def ask_user_for_config
  server_name = guess_servername
  @chef_server = config[:chef_server_url] || ask_question("Please enter the chef server URL: ", :default => "https://#{server_name}/organizations/myorg")
  if config[:initial]
    @new_client_name        = config[:node_name] || ask_question("Please enter a name for the new user: ", :default => Etc.getlogin)
    @admin_client_name      = config[:admin_client_name] || ask_question("Please enter the existing admin name: ", :default => "admin")
    @admin_client_key       = config[:admin_client_key] || ask_question("Please enter the location of the existing admin's private key: ", :default => "/etc/chef-server/admin.pem")
    @admin_client_key       = File.expand_path(@admin_client_key)
  else
    @new_client_name        = config[:node_name] || ask_question("Please enter an existing username or clientname for the API: ", :default => Etc.getlogin)
  end
  @validation_client_name = config[:validation_client_name] || ask_question("Please enter the validation clientname: ", :default => "chef-validator")
  @validation_key         = config[:validation_key] || ask_question("Please enter the location of the validation key: ", :default => "/etc/chef-server/chef-validator.pem")
  @validation_key         = File.expand_path(@validation_key)
  @chef_repo              = config[:repository] || ask_question("Please enter the path to a chef repository (or leave blank): ")

  @new_client_key = config[:client_key] || File.join(chef_config_path, "#{@new_client_name}.pem")
  @new_client_key = File.expand_path(@new_client_key)
end

#ask_user_for_config_pathObject


123
124
125
126
127
128
129
130
# File 'lib/chef/knife/configure.rb', line 123

def ask_user_for_config_path
  config[:config_file] ||= ask_question("Where should I put the config file? ", :default => "#{Chef::Config[:user_home]}/.chef/knife.rb")
  # have to use expand path to expand the tilde character to the user's home
  config[:config_file] = File.expand_path(config[:config_file])
  if File.exists?(config[:config_file])
    confirm("Overwrite #{config[:config_file]}")
  end
end

#chef_config_pathObject


164
165
166
# File 'lib/chef/knife/configure.rb', line 164

def chef_config_path
  File.dirname(config_file)
end

#config_fileObject


160
161
162
# File 'lib/chef/knife/configure.rb', line 160

def config_file
  config[:config_file]
end

#configure_chefObject


62
63
64
65
66
67
# File 'lib/chef/knife/configure.rb', line 62

def configure_chef
  # We are just faking out the system so that you can do this without a key specified
  Chef::Config[:node_name] = "woot"
  super
  Chef::Config[:node_name] = nil
end

#guess_servernameObject


152
153
154
155
156
157
158
# File 'lib/chef/knife/configure.rb', line 152

def guess_servername
  o = Ohai::System.new
  o.load_plugins
  o.require_plugin "os"
  o.require_plugin "hostname"
  o[:fqdn] || o[:machinename] || o[:hostname] || "localhost"
end

#runObject


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
# File 'lib/chef/knife/configure.rb', line 69

def run
  ask_user_for_config_path

  FileUtils.mkdir_p(chef_config_path)

  ask_user_for_config

  ::File.open(config[:config_file], "w") do |f|
    f.puts "node_name                '\#{new_client_name}'\nclient_key               '\#{new_client_key}'\nvalidation_client_name   '\#{validation_client_name}'\nvalidation_key           '\#{validation_key}'\nchef_server_url          '\#{chef_server}'\nsyntax_check_cache_path  '\#{File.join(chef_config_path, \"syntax_check_cache\")}'\n"
    unless chef_repo.empty?
      f.puts "cookbook_path [ '#{chef_repo}/cookbooks' ]"
    end
  end

  if config[:initial]
    ui.msg("Creating initial API user...")
    Chef::Config[:chef_server_url] = chef_server
    Chef::Config[:node_name] = admin_client_name
    Chef::Config[:client_key] = admin_client_key
    user_create = Chef::Knife::UserCreate.new
    user_create.name_args = [ new_client_name ]
    user_create.config[:user_password] = config[:user_password] ||
      ui.ask("Please enter a password for the new user: ") { |q| q.echo = false }
    user_create.config[:admin] = true
    user_create.config[:file] = new_client_key
    user_create.config[:yes] = true
    user_create.config[:disable_editing] = true
    user_create.run
  else
    ui.msg("*****")
    ui.msg("")
    ui.msg("You must place your client key in:")
    ui.msg("  #{new_client_key}")
    ui.msg("Before running commands with Knife")
    ui.msg("")
    ui.msg("*****")
    ui.msg("")
    ui.msg("You must place your validation key in:")
    ui.msg("  #{validation_key}")
    ui.msg("Before generating instance data with Knife")
    ui.msg("")
    ui.msg("*****")
  end

  ui.msg("Configuration file written to #{config[:config_file]}")
end