chef 10.34.6-x86-mingw32 → 11.6.2-x86-mingw32

data/lib/chef/knife.rb

@@ -57,6 +57,11 @@ class Chef
     attr_accessor :name_args
     attr_accessor :ui
 
+    # Configure mixlib-cli to always separate defaults from user-supplied CLI options
+    def self.use_separate_defaults?
+      true
+    end
+
     def self.ui
       @ui ||= Chef::Knife::UI.new(STDOUT, STDERR, STDIN, {})
     end
@@ -145,7 +150,7 @@ class Chef
       commands_to_show.sort.each do |category, commands|
         next if category =~ /deprecated/i
         msg "** #{category.upcase} COMMANDS **"
-        commands.each do |command|
+        commands.sort.each do |command|
           msg subcommands[command].banner if subcommands[command]
         end
         msg
@@ -196,12 +201,18 @@ class Chef
       subcommand_class || subcommand_not_found!(args)
     end
 
+    def self.dependency_loaders
+      @dependency_loaders ||= []
+    end
+
     def self.deps(&block)
-      @dependency_loader = block
+      dependency_loaders << block
     end
 
     def self.load_deps
-      @dependency_loader && @dependency_loader.call
+      dependency_loaders.each do |dep_loader|
+        dep_loader.call
+      end
     end
 
     private
@@ -226,13 +237,22 @@ class Chef
       exit 10
     end
 
-    @@chef_config_dir = nil
+    def self.working_directory
+      ENV['PWD'] || Dir.pwd
+    end
+
+    def self.reset_config_path!
+      @@chef_config_dir = nil
+    end
+
+    reset_config_path!
+
 
     # search upward from current_dir until .chef directory is found
     def self.chef_config_dir
       if @@chef_config_dir.nil? # share this with subclasses
         @@chef_config_dir = false
-        full_path = Dir.pwd.split(File::SEPARATOR)
+        full_path = working_directory.split(File::SEPARATOR)
         (full_path.length - 1).downto(0) do |i|
           candidate_directory = File.join(full_path[0..i] + [".chef" ])
           if File.exist?(candidate_directory) && File.directory?(candidate_directory)
@@ -283,49 +303,70 @@ class Chef
       exit(1)
     end
 
-    def configure_chef
-      unless config[:config_file]
-        candidate_configs = []
+    # Returns a subset of the Chef::Config[:knife] 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.
+    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
 
-        # Look for $KNIFE_HOME/knife.rb (allow multiple knives config on same machine)
-        if ENV['KNIFE_HOME']
-          candidate_configs << File.join(ENV['KNIFE_HOME'], 'knife.rb')
-        end
-        # Look for $PWD/knife.rb
-        if Dir.pwd
-          candidate_configs << File.join(Dir.pwd, 'knife.rb')
-        end
-        # Look for $UPWARD/.chef/knife.rb
-        if self.class.chef_config_dir
-          candidate_configs << File.join(self.class.chef_config_dir, 'knife.rb')
-        end
-        # Look for $HOME/.chef/knife.rb
-        if ENV['HOME']
-          candidate_configs << File.join(ENV['HOME'], '.chef', 'knife.rb')
-        end
+    def locate_config_file
+      candidate_configs = []
 
-        candidate_configs.each do | candidate_config |
-          candidate_config = File.expand_path(candidate_config)
-          if File.exist?(candidate_config)
-            config[:config_file] = candidate_config
-            break
-          end
-        end
+      # Look for $KNIFE_HOME/knife.rb (allow multiple knives config on same machine)
+      if ENV['KNIFE_HOME']
+        candidate_configs << File.join(ENV['KNIFE_HOME'], 'knife.rb')
+      end
+      # Look for $PWD/knife.rb
+      if Dir.pwd
+        candidate_configs << File.join(Dir.pwd, 'knife.rb')
+      end
+      # Look for $UPWARD/.chef/knife.rb
+      if self.class.chef_config_dir
+        candidate_configs << File.join(self.class.chef_config_dir, 'knife.rb')
+      end
+      # Look for $HOME/.chef/knife.rb
+      if ENV['HOME']
+        candidate_configs << File.join(ENV['HOME'], '.chef', 'knife.rb')
       end
 
-      # Don't try to load a knife.rb if it doesn't exist.
-      if config[:config_file]
-        read_config_file(config[:config_file])
-      else
-        # ...but do log a message if no config was found.
-        Chef::Config[:color] = config[:color]
-        ui.warn("No knife configuration file found")
+      candidate_configs.each do | candidate_config |
+        candidate_config = File.expand_path(candidate_config)
+        if File.exist?(candidate_config)
+          config[:config_file] = candidate_config
+          break
+        end
       end
+    end
 
+    # Apply Config in this order:
+    # defaults from mixlib-cli
+    # settings from config file, via Chef::Config[:knife]
+    # config from command line
+    def merge_configs
+      # Apply config file settings on top of mixlib-cli defaults
+      combined_config = default_config.merge(config_file_settings)
+      # Apply user-supplied options on top of the above combination
+      combined_config = combined_config.merge(config)
+      # replace the config hash from mixlib-cli with our own.
+      # Need to use the mutate-in-place #replace method instead of assigning to
+      # the instance variable because other code may have a reference to the
+      # original config hash object.
+      config.replace(combined_config)
+    end
+
+    # Catch-all method that does any massaging needed for various config
+    # components, such as expanding file paths and converting verbosity level
+    # into log level.
+    def apply_computed_config
       Chef::Config[:color] = config[:color]
 
       case Chef::Config[:verbosity]
-      when 0
+      when 0, nil
         Chef::Config[:log_level] = :error
       when 1
         Chef::Config[:log_level] = :info
@@ -348,8 +389,6 @@ class Chef
       Chef::Log.init(Chef::Config[:log_location])
       Chef::Log.level(Chef::Config[:log_level] || :error)
 
-      Chef::Log.debug("Using configuration from #{config[:config_file]}")
-      
       if Chef::Config[:node_name] && Chef::Config[:node_name].bytesize > 90
         # node names > 90 bytes only work with authentication protocol >= 1.1
         # see discussion in config.rb.
@@ -357,6 +396,25 @@ class Chef
       end
     end
 
+    def configure_chef
+      unless config[:config_file]
+        locate_config_file
+      end
+
+      # Don't try to load a knife.rb if it doesn't exist.
+      if config[:config_file]
+        Chef::Log.debug("Using configuration from #{config[:config_file]}")
+        read_config_file(config[:config_file])
+      else
+        # ...but do log a message if no config was found.
+        Chef::Config[:color] = config[:color]
+        ui.warn("No knife configuration file found")
+      end
+
+      merge_configs
+      apply_computed_config
+    end
+
     def read_config_file(file)
       Chef::Config.from_file(file)
     rescue SyntaxError => e

data/lib/chef/knife/bootstrap.rb

@@ -59,6 +59,12 @@ class Chef
         :description => "The ssh gateway",
         :proc => Proc.new { |key| Chef::Config[:knife][:ssh_gateway] = key }
 
+      option :forward_agent,
+        :short => "-A",
+        :long => "--forward-agent",
+        :description => "Enable SSH agent forwarding",
+        :boolean => true
+
       option :identity_file,
         :short => "-i IDENTITY_FILE",
         :long => "--identity-file IDENTITY_FILE",
@@ -94,6 +100,11 @@ class Chef
         :description => "Execute the bootstrap via sudo",
         :boolean => true
 
+      option :use_sudo_password,
+        :long => "--use-sudo-password",
+        :description => "Execute the bootstrap via sudo with password",
+        :boolean => false
+
       option :template_file,
         :long => "--template-file TEMPLATE",
         :description => "Full path to location of template to use",
@@ -127,6 +138,15 @@ class Chef
           name, path = h.split("=")
           Chef::Config[:knife][:hints][name] = path ? JSON.parse(::File.read(path)) : Hash.new  }
 
+      option :secret,
+        :short => "-s SECRET",
+        :long  => "--secret ",
+        :description => "The secret key to use to encrypt data bag item values"
+
+      option :secret_file,
+        :long => "--secret-file SECRET_FILE",
+        :description => "A file containing the secret key to use to encrypt data bag item values"
+
       def find_template(template=nil)
         # Are we bootstrapping using an already shipped template?
         if config[:template_file]
@@ -166,11 +186,12 @@ class Chef
 
       def run
         validate_name_args!
+        warn_chef_config_secret_key
         @template_file = find_template(config[:bootstrap_template])
         @node_name = Array(@name_args).first
         # back compat--templates may use this setting:
         config[:server_name] = @node_name
-        
+
         $stdout.sync = true
 
         ui.info("Bootstrapping Chef on #{ui.color(@node_name, :bold)}")
@@ -204,6 +225,7 @@ class Chef
         ssh.config[:ssh_password] = config[:ssh_password]
         ssh.config[:ssh_port] = Chef::Config[:knife][:ssh_port] || config[:ssh_port]
         ssh.config[:ssh_gateway] = Chef::Config[:knife][:ssh_gateway] || config[:ssh_gateway]
+        ssh.config[:forward_agent] = Chef::Config[:knife][:forward_agent] || config[:forward_agent]
         ssh.config[:identity_file] = Chef::Config[:knife][:identity_file] || config[:identity_file]
         ssh.config[:manual] = true
         ssh.config[:host_key_verify] = Chef::Config[:knife][:host_key_verify] || config[:host_key_verify]
@@ -222,12 +244,34 @@ class Chef
         command = render_template(read_template)
 
         if config[:use_sudo]
-          command = "sudo #{command}"
+          command = config[:use_sudo_password] ? "echo #{config[:ssh_password]} | sudo -S #{command}" : "sudo #{command}"
         end
 
         command
       end
 
+      def warn_chef_config_secret_key
+        unless Chef::Config[:encrypted_data_bag_secret].nil?
+          ui.warn "* " * 40
+          ui.warn(<<-WARNING)
+Specifying the encrypted data bag secret key using an 'encrypted_data_bag_secret'
+entry in 'knife.rb' is deprecated. Please see CHEF-4011 for more details. You
+can supress this warning and still distribute the secret key to all bootstrapped
+machines by adding the following to your 'knife.rb' file:
+
+  knife[:secret_file] = "/path/to/your/secret"
+
+If you would like to selectively distribute a secret key during bootstrap
+please use the '--secret' or '--secret-file' options of this command instead.
+
+#{ui.color('IMPORTANT:', :red, :bold)} In a future version of Chef, this
+behavior will be removed and any 'encrypted_data_bag_secret' entries in
+'knife.rb' will be ignored completely.
+WARNING
+          ui.warn "* " * 40
+        end
+      end
+
     end
   end
 end

data/lib/chef/knife/bootstrap/archlinux-gems.erb

@@ -16,7 +16,7 @@ cat > /etc/chef/validation.pem <<'EOP'
 EOP
 chmod 0600 /etc/chef/validation.pem
 
-<% if @chef_config[:encrypted_data_bag_secret] -%>
+<% if encrypted_data_bag_secret -%>
 cat > /etc/chef/encrypted_data_bag_secret <<'EOP'
 <%= encrypted_data_bag_secret %>
 EOP

data/lib/chef/knife/bootstrap/centos5-gems.erb

@@ -33,7 +33,7 @@ cat > /etc/chef/validation.pem <<'EOP'
 EOP
 chmod 0600 /etc/chef/validation.pem
 
-<% if @chef_config[:encrypted_data_bag_secret] -%>
+<% if encrypted_data_bag_secret -%>
 cat > /etc/chef/encrypted_data_bag_secret <<'EOP'
 <%= encrypted_data_bag_secret %>
 EOP

data/lib/chef/knife/bootstrap/chef-full.erb

@@ -31,7 +31,7 @@ cat > /etc/chef/validation.pem <<'EOP'
 EOP
 chmod 0600 /etc/chef/validation.pem
 
-<% if @chef_config[:encrypted_data_bag_secret] -%>
+<% if encrypted_data_bag_secret -%>
 cat > /etc/chef/encrypted_data_bag_secret <<'EOP'
 <%= encrypted_data_bag_secret %>
 EOP

data/lib/chef/knife/bootstrap/fedora13-gems.erb

@@ -15,7 +15,7 @@ cat > /etc/chef/validation.pem <<'EOP'
 EOP
 chmod 0600 /etc/chef/validation.pem
 
-<% if @chef_config[:encrypted_data_bag_secret] -%>
+<% if encrypted_data_bag_secret -%>
 cat > /etc/chef/encrypted_data_bag_secret <<'EOP'
 <%= encrypted_data_bag_secret %>
 EOP

data/lib/chef/knife/bootstrap/ubuntu10.04-apt.erb

@@ -15,7 +15,7 @@ cat > /etc/chef/validation.pem <<'EOP'
 EOP
 chmod 0600 /etc/chef/validation.pem
 
-<% if @chef_config[:encrypted_data_bag_secret] -%>
+<% if encrypted_data_bag_secret -%>
 cat > /etc/chef/encrypted_data_bag_secret <<'EOP'
 <%= encrypted_data_bag_secret %>
 EOP

data/lib/chef/knife/bootstrap/ubuntu10.04-gems.erb

@@ -19,7 +19,7 @@ cat > /etc/chef/validation.pem <<'EOP'
 EOP
 chmod 0600 /etc/chef/validation.pem
 
-<% if @chef_config[:encrypted_data_bag_secret] -%>
+<% if encrypted_data_bag_secret -%>
 cat > /etc/chef/encrypted_data_bag_secret <<'EOP'
 <%= encrypted_data_bag_secret %>
 EOP

data/lib/chef/knife/bootstrap/ubuntu12.04-gems.erb

@@ -17,7 +17,7 @@ cat > /etc/chef/validation.pem <<'EOP'
 EOP
 chmod 0600 /etc/chef/validation.pem
 
-<% if @chef_config[:encrypted_data_bag_secret] -%>
+<% if encrypted_data_bag_secret -%>
 cat > /etc/chef/encrypted_data_bag_secret <<'EOP'
 <%= encrypted_data_bag_secret %>
 EOP

data/lib/chef/knife/client_show.rb

@@ -22,6 +22,8 @@ class Chef
   class Knife
     class ClientShow < Knife
 
+      include Knife::Core::MultiAttributeReturnOption
+
       deps do
         require 'chef/api_client'
         require 'chef/json_compat'
@@ -29,11 +31,6 @@ class Chef
 
       banner "knife client show CLIENT (options)"
 
-      option :attribute,
-        :short => "-a ATTR",
-        :long => "--attribute ATTR",
-        :description => "Show only one attribute"
-
       def run
         @client_name = @name_args[0]
 

data/lib/chef/knife/configure.rb

@@ -27,6 +27,7 @@ class Chef
       deps do
         require 'ohai'
         Chef::Knife::ClientCreate.load_deps
+        Chef::Knife::UserCreate.load_deps
       end
 
       banner "knife configure (options)"
@@ -40,15 +41,15 @@ class Chef
         :short => "-i",
         :long => "--initial",
         :boolean => true,
-        :description => "Create an initial API Client"
+        :description => "Create an initial API User"
 
       option :admin_client_name,
         :long => "--admin-client-name NAME",
-        :description => "The existing admin clientname (usually chef-webui)"
+        :description => "The existing admin clientname (usually admin)"
 
       option :admin_client_key,
         :long => "--admin-client-key PATH",
-        :description => "The path to the admin client's private key (usually a file named webui.pem)"
+        :description => "The path to the admin client's private key (usually a file named admin.pem)"
 
       option :validation_client_name,
         :long => "--validation-client-name NAME",
@@ -81,8 +82,7 @@ client_key               '#{new_client_key}'
 validation_client_name   '#{validation_client_name}'
 validation_key           '#{validation_key}'
 chef_server_url          '#{chef_server}'
-cache_type               'BasicFile'
-cache_options( :path => '#{File.join(chef_config_path, "checksums")}' )
+syntax_check_cache_path  '#{File.join(chef_config_path, "syntax_check_cache")}'
 EOH
           unless chef_repo.empty?
             f.puts "cookbook_path [ '#{chef_repo}/cookbooks' ]"
@@ -94,13 +94,15 @@ EOH
           Chef::Config[:chef_server_url] = chef_server
           Chef::Config[:node_name] = admin_client_name
           Chef::Config[:client_key] = admin_client_key
-          client_create = Chef::Knife::ClientCreate.new
-          client_create.name_args = [ new_client_name ]
-          client_create.config[:admin] = true
-          client_create.config[:file] = new_client_key
-          client_create.config[:yes] = true
-          client_create.config[:disable_editing] = true
-          client_create.run
+          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("")
@@ -131,17 +133,17 @@ EOH
 
       def ask_user_for_config
         server_name = guess_servername
-        @chef_server            = config[:chef_server_url] || ask_question("Please enter the chef server URL: ", :default => "http://#{server_name}:4000")
+        @chef_server            = config[:chef_server_url] || ask_question("Please enter the chef server URL: ", :default => "https://#{server_name}:443")
         if config[:initial]
-          @new_client_name        = config[:node_name] || ask_question("Please enter a clientname for the new client: ", :default => Etc.getlogin)
-          @admin_client_name      = config[:admin_client_name] || ask_question("Please enter the existing admin clientname: ", :default => 'chef-webui')
-          @admin_client_key       = config[:admin_client_key] || ask_question("Please enter the location of the existing admin client's private key: ", :default => '/etc/chef/webui.pem')
+          @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/validation.pem')
+        @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): ")