knife-windows 1.9.6 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bf0c4e742d3b1f2c96348ae916c2c6521d61a41f316077c91a66639b1370279
-  data.tar.gz: 11d10a40bb240102a06ae7fd8603afd3bb6bf231dd25e364b5126bd9046a6e2c
+  metadata.gz: 9df0cbd0a270e724605457a247247450e280c06fec21039fbf6f3a7603d96e88
+  data.tar.gz: 0010acbcbceb5b3a95366591aa79dcacc08eb47e7c3c40da236df7ca1dc61880
 SHA512:
-  metadata.gz: f07208ca07546853389ab4c7646b4cfdaca43cfb39b90fe86cccc73d286a4b07a9e3015a89d2a734e25fec99c37122446c67519dc40cd806f05b4e11f7e15b3f
-  data.tar.gz: 3d81398062e1f4393072f172f8cc7bdb44a92c7f2cbd4db72305cf74b1b38a14a3c4dc7f9b1b00a8173eb53612084d97f32b2cdecb58474cf0d22ce00e67eee9
+  metadata.gz: ed4db6cce0bb4db8ccac3c1c59bc611f2584f5db4751462c8560639889d22070f9f5bfde616cdcc8a3e985b96395c2039b1bd1890e4d2776717083ee1e439f03
+  data.tar.gz: da60e7d18999d01e07c6a9510abaf07a6c8b550eead498f4d760ab044bc93ab80e95696b86c38bc4348c242e4371b41d4841c4e0b3332d1b1138dd12e1a1d816

data/lib/chef/knife/bootstrap_windows_base.rb

@@ -19,10 +19,8 @@
 require 'chef/knife'
 require 'chef/knife/bootstrap'
 require 'chef/encrypted_data_bag_item'
-require 'chef/knife/core/windows_bootstrap_context'
 require 'chef/knife/knife_windows_base'
-# Chef 11 PathHelper doesn't have #home
-#require 'chef/util/path_helper'
+require 'chef/util/path_helper'
 
 class Chef
   class Knife
@@ -70,30 +68,11 @@ class Chef
             :description => "Custom command to install chef-client",
             :proc        => Proc.new { |ic| Chef::Config[:knife][:bootstrap_install_command] = ic }
 
-          # DEPR: Remove this option in Chef 13
-          option :distro,
-            :short => "-d DISTRO",
-            :long => "--distro DISTRO",
-            :description => "Bootstrap a distro using a template. [DEPRECATED] Use -t / --bootstrap-template option instead.",
-            :proc        => Proc.new { |v|
-              Chef::Log.warn("[DEPRECATED] -d / --distro option is deprecated. Use --bootstrap-template option instead.")
-              v
-            }
-
           option :bootstrap_template,
             :short => "-t TEMPLATE",
             :long => "--bootstrap-template TEMPLATE",
             :description => "Bootstrap Chef using a built-in or custom template. Set to the full path of an erb template or use one of the built-in templates."
 
-          # DEPR: Remove this option in Chef 13
-          option :template_file,
-            :long => "--template-file TEMPLATE",
-            :description => "Full path to location of template to use. [DEPRECATED] Use -t / --bootstrap-template option instead.",
-            :proc        => Proc.new { |v|
-              Chef::Log.warn("[DEPRECATED] --template-file option is deprecated. Use --bootstrap-template option instead.")
-              v
-            }
-
           option :run_list,
             :short => "-r RUN_LIST",
             :long => "--run-list RUN_LIST",
@@ -203,243 +182,6 @@ class Chef
             :default => []
         end
       end
-
-      def default_bootstrap_template
-        "windows-chef-client-msi"
-      end
-
-      def bootstrap_template
-        # The order here is important. We want to check if we have the new Chef 12 option is set first.
-        # Knife cloud plugins unfortunately all set a default option for the :distro so it should be at
-        # the end.
-        config[:bootstrap_template] || config[:template_file] || config[:distro] || default_bootstrap_template
-      end
-
-       # TODO: This should go away when CHEF-2193 is fixed
-      def load_template(template=nil)
-        # Are we bootstrapping using an already shipped template?
-
-        template = bootstrap_template
-
-        # Use the template directly if it's a path to an actual file
-        if File.exists?(template)
-          Chef::Log.debug("Using the specified bootstrap template: #{File.dirname(template)}")
-          return IO.read(template).chomp
-        end
-
-        # Otherwise search the template directories until we find the right one
-        bootstrap_files = []
-        bootstrap_files << File.join(File.dirname(__FILE__), 'bootstrap/templates', "#{template}.erb")
-        bootstrap_files << File.join(Knife.chef_config_dir, "bootstrap", "#{template}.erb") if Chef::Knife.chef_config_dir
-        ::Knife::Windows::PathHelper.all_homes('.chef', 'bootstrap', "#{template}.erb") { |p| bootstrap_files << p }
-        bootstrap_files << Gem.find_files(File.join("chef","knife","bootstrap","#{template}.erb"))
-        bootstrap_files.flatten!
-
-        template = Array(bootstrap_files).find do |bootstrap_template|
-          Chef::Log.debug("Looking for bootstrap template in #{File.dirname(bootstrap_template)}")
-          ::File.exists?(bootstrap_template)
-        end
-
-        unless template
-          ui.info("Can not find bootstrap definition for #{config[:distro]}")
-          raise Errno::ENOENT
-        end
-
-        Chef::Log.debug("Found bootstrap template in #{File.dirname(template)}")
-
-        IO.read(template).chomp
-      end
-
-      def bootstrap_context
-        @bootstrap_context ||= Knife::Core::WindowsBootstrapContext.new(config, config[:run_list], Chef::Config)
-      end
-
-      def load_correct_secret
-        knife_secret_file = Chef::Config[:knife][:encrypted_data_bag_secret_file]
-        knife_secret = Chef::Config[:knife][:encrypted_data_bag_secret]
-        cli_secret_file = config[:encrypted_data_bag_secret_file]
-        cli_secret = config[:encrypted_data_bag_secret]
-
-        cli_secret_file = nil if cli_secret_file == knife_secret_file
-        cli_secret = nil if cli_secret == knife_secret
-
-        cli_secret_file = Chef::EncryptedDataBagItem.load_secret(cli_secret_file) if cli_secret_file != nil
-        knife_secret_file = Chef::EncryptedDataBagItem.load_secret(knife_secret_file) if knife_secret_file != nil
-
-        cli_secret_file || cli_secret || knife_secret_file || knife_secret
-      end
-
-      def first_boot_attributes
-        config[:first_boot_attributes] || config[:first_boot_attributes_from_file] || {}
-      end
-
-      def render_template(template=nil)
-        config[:first_boot_attributes] = first_boot_attributes
-        config[:secret] = load_correct_secret
-        Erubis::Eruby.new(template).evaluate(bootstrap_context)
-      end
-
-      def bootstrap(proto=nil)
-        if Chef::Config[:knife][:encrypted_data_bag_secret_file] || Chef::Config[:knife][:encrypted_data_bag_secret]
-          warn_chef_config_secret_key
-        end
-
-        set_target_architecture
-
-        # adding respond_to? so this works with pre 12.4 chef clients
-        validate_options! if respond_to?(:validate_options!)
-
-        @node_name = Array(@name_args).first
-        # back compat--templates may use this setting:
-        config[:server_name] = @node_name
-
-        STDOUT.sync = STDERR.sync = true
-
-        if Chef::VERSION.split('.').first.to_i == 11 && Chef::Config[:validation_key] && !File.exist?(File.expand_path(Chef::Config[:validation_key]))
-          ui.error("Unable to find validation key. Please verify your configuration file for validation_key config value.")
-          exit 1
-        end
-
-        if (defined?(chef_vault_handler) && chef_vault_handler.doing_chef_vault?) ||
-            (Chef::Config[:validation_key] && !File.exist?(File.expand_path(Chef::Config[:validation_key])))
-
-          unless locate_config_value(:chef_node_name)
-            ui.error("You must pass a node name with -N when bootstrapping with user credentials")
-            exit 1
-          end
-
-          client_builder.run
-
-          if client_builder.respond_to?(:client)
-            chef_vault_handler.run(client_builder.client)
-          else
-            chef_vault_handler.run(node_name: config[:chef_node_name])
-          end
-
-          bootstrap_context.client_pem = client_builder.client_path
-
-        else
-          ui.info("Doing old-style registration with the validation key at #{Chef::Config[:validation_key]}...")
-          ui.info("Delete your validation key in order to use your user credentials instead")
-          ui.info("")
-        end
-
-        wait_for_remote_response( config[:auth_timeout].to_i )
-
-        ui.info("Bootstrapping Chef on #{ui.color(@node_name, :bold)}")
-        # create a bootstrap.bat file on the node
-        # we have to run the remote commands in 2047 char chunks
-        create_bootstrap_bat_command do |command_chunk|
-          render_command_result = run_command(command_chunk)
-          unless render_command_result == 0
-            ui.error("Batch render command returned #{render_command_result}")
-            exit render_command_result
-          end
-        end
-
-        # execute the bootstrap.bat file
-        bootstrap_command_result = run_command(bootstrap_command)
-        unless bootstrap_command_result == 0
-          ui.error("Bootstrap command returned #{bootstrap_command_result}")
-          exit bootstrap_command_result
-        end
-
-        # exit 0
-        0
-      end
-
-      protected
-
-      # Default implementation -- override only if required by the transport
-      def wait_for_remote_response(wait_max_minutes)
-      end
-
-      def bootstrap_command
-        @bootstrap_command ||= "cmd.exe /C #{bootstrap_bat_file}"
-      end
-
-      def bootstrap_render_banner_command(chunk_num)
-        "cmd.exe /C echo Rendering #{bootstrap_bat_file} chunk #{chunk_num}"
-      end
-
-      def escape_windows_batch_characters(line)
-        # TODO: The commands are going to get redirected - do we need to escape &?
-        line.gsub!(/[(<|>)^]/).each{|m| "^#{m}"}
-      end
-
-      def create_bootstrap_bat_command()
-        chunk_num = 0
-        bootstrap_bat = ""
-        banner = bootstrap_render_banner_command(chunk_num += 1)
-        render_template(load_template(config[:bootstrap_template])).each_line do |line|
-          escape_windows_batch_characters(line)
-          # We are guaranteed to have a prefix "banner" command that echo's chunk number.  We can
-          # confidently prefix every actual command with &&.
-          # TODO: Why does ^\n&& work directly through the commandline but not through SOAP?
-          render_line = " && >> #{bootstrap_bat_file} (echo.#{line.chomp.strip})"
-          # Windows commands are limited to 8191 characters for machines running XP or higher but
-          # this includes the length of environment variables after they have been expanded.
-          # Since we don't actually know how long %TEMP% (and it's used twice - once in the banner
-          # and once in every command redirection), we simply guess and set the max to 5000.
-          # TODO: When a more accurate method is available, fix this.
-          if bootstrap_bat.length + render_line.length + banner.length > 5000
-            # Can't fit it into this chunk? - flush (if necessary) and then try.
-            # Do this first because banner.length might change (e.g. due to an extra digit) and
-            # prevent a fit.
-            unless bootstrap_bat.empty?
-              yield banner + bootstrap_bat
-              bootstrap_bat = ""
-              banner = bootstrap_render_banner_command(chunk_num += 1)
-            end
-            # Will this ever fit?
-            if render_line.length + banner.length > 5000
-              raise "Command in bootstrap template too long by #{render_line.length + banner.length - 5000} characters : #{line}"
-            end
-          end
-          bootstrap_bat << render_line
-        end
-        raise "Bootstrap template was empty!  Check #{config[:bootstrap_template]}" if bootstrap_bat.empty?
-        yield banner + bootstrap_bat
-      end
-
-      def bootstrap_bat_file
-        @bootstrap_bat_file ||= "\"%TEMP%\\bootstrap-#{Process.pid}-#{Time.now.to_i}.bat\""
-      end
-
-      def warn_chef_config_secret_key
-        ui.info "* " * 40
-        ui.warn(<<-WARNING)
-\nSpecifying the encrypted data bag secret key using an 'encrypted_data_bag_secret'
-entry in 'knife.rb' is deprecated. 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.info "* " * 40
-      end
-
-      # We allow the user to specify the desired architecture of Chef to install or we default
-      # to whatever the target system is.
-      # This is because a user might want to install a 32bit chef client on a 64bit machine
-      def set_target_architecture
-        if Chef::Config[:knife][:architecture]
-          raise "Do not set :architecture in your knife config, use :bootstrap_architecture."
-        end
-
-        if Chef::Config[:knife][:bootstrap_architecture]
-          bootstrap_architecture = Chef::Config[:knife][:bootstrap_architecture]
-
-          if ![:x86_64, :i386].include?(bootstrap_architecture.to_sym)
-            raise "Valid values for the knife config :bootstrap_architecture are i386 or x86_64. Supplied value is #{bootstrap_architecture}"
-          end
-
-          # The windows install script wants i686, not i386
-          bootstrap_architecture = :i686 if bootstrap_architecture == :i386
-          Chef::Config[:knife][:architecture] = bootstrap_architecture
-        end
-      end
     end
   end
 end

data/lib/chef/knife/bootstrap_windows_ssh.rb

@@ -25,13 +25,13 @@ class Chef
       include Chef::Knife::BootstrapWindowsBase
 
       deps do
-        require 'chef/knife/core/windows_bootstrap_context'
         require 'chef/json_compat'
         require 'tempfile'
         require 'highline'
         require 'net/ssh'
         require 'net/ssh/multi'
         Chef::Knife::Ssh.load_deps
+        Chef::Knife::Bootstrap.load_deps
       end
 
       banner "knife bootstrap windows ssh FQDN (options)"
@@ -74,17 +74,6 @@ class Chef
         :long => "--ssh-identity-file IDENTITY_FILE",
         :description => "The SSH identity file used for authentication"
 
-      # DEPR: Remove this option for the next release.
-      option :host_key_verification,
-        :long => "--[no-]host-key-verify",
-        :description => "Verify host key, enabled by default. [DEPRECATED] Use --host-key-verify option instead.",
-        :boolean => true,
-        :default => true,
-        :proc => Proc.new { |key|
-          Chef::Log.warn("[DEPRECATED] --host-key-verification option is deprecated. Use --host-key-verify option instead.")
-          config[:host_key_verify] = key
-        }
-
       option :host_key_verify,
         :long => "--[no-]host-key-verify",
         :description => "Verify host key, enabled by default.",
@@ -92,23 +81,15 @@ class Chef
         :default => true
 
       def run
-        validate_name_args!
-        bootstrap
-      end
-
-      def run_command(command = '')
-        ssh = Chef::Knife::Ssh.new
-        ssh.name_args = [ server_name, command ]
-        ssh.config[:ssh_user] = locate_config_value(:ssh_user)
-        ssh.config[:ssh_password] = locate_config_value(:ssh_password)
-        ssh.config[:ssh_port] = locate_config_value(:ssh_port)
-        ssh.config[:ssh_gateway] =  locate_config_value(:ssh_gateway)
-        ssh.config[:identity_file] = config[:identity_file]
-        ssh.config[:ssh_identity_file] = config[:ssh_identity_file] || config[:identity_file]
-        ssh.config[:forward_agent] = config[:forward_agent]
-        ssh.config[:manual] = true
-        ssh.config[:host_key_verify] = config[:host_key_verify]
-        ssh.run
+         Chef::Application.fatal!(<<~EOM
+         *knife windows bootstrap ssh*
+          Core Chef now supports bootstrapping Windows systems without a knife plugin
+          
+          Use 'knife bootstrap -o ssh' instead.
+          
+          For more detail https://github.com/chef/chef/blob/master/RELEASE_NOTES.md#knife-bootstrap
+          EOM
+          )
       end
 
     end

data/lib/chef/knife/bootstrap_windows_winrm.rb

@@ -31,72 +31,26 @@ class Chef
       include Chef::Knife::WinrmCommandSharedFunctions
 
       deps do
-        require 'chef/knife/core/windows_bootstrap_context'
         require 'chef/json_compat'
         require 'tempfile'
         Chef::Knife::Winrm.load_deps
+        Chef::Knife::Bootstrap.load_deps
       end
 
       banner 'knife bootstrap windows winrm FQDN (options)'
 
       def run
-        validate_name_args!
-
-        if (Chef::Config[:validation_key] && !File.exist?(File.expand_path(Chef::Config[:validation_key])))
-          if !negotiate_auth? && !(locate_config_value(:winrm_transport) == 'ssl')
-            ui.error('Validatorless bootstrap over unsecure winrm channels could expose your key to network sniffing')
-            exit 1
-          end
-        end
-
-        unless locate_config_value(:winrm_shell) == :cmd
-          ui.warn("The cmd shell is the only valid winrm-shell for 'knife bootstrap windows winrm'. Switching to the cmd shell.")
-          config[:winrm_shell] = :cmd
-        end
-
-        config[:manual] = true
-        configure_session
-
-        bootstrap
+         Chef::Application.fatal!(<<~EOM
+         *knife windows bootstrap winrm*
+          Core Chef now supports bootstrapping Windows systems without a knife plugin
+          
+          Use 'knife bootstrap -o winrm' instead.
+          
+          For more detail https://github.com/chef/chef/blob/master/RELEASE_NOTES.md#knife-bootstrap
+          EOM
+          )
       end
 
-      protected
-
-      def wait_for_remote_response(wait_max_minutes)
-        wait_max_seconds = wait_max_minutes * 60
-        retry_interval_seconds = 10
-        retries_left = wait_max_seconds / retry_interval_seconds
-        print(ui.color("\nWaiting for remote response before bootstrap", :magenta))
-        wait_start_time = Time.now
-        begin
-          print(".")
-          # Return status of the command is non-zero, typically nil,
-          # for our simple echo command in cases where run_command
-          # swallows the exception, such as 401's. Treat such cases
-          # the same as the case where we encounter an exception.
-          status = run_command("echo . & echo Response received.")
-          raise RuntimeError, 'Command execution failed.' if status != 0
-          ui.info(ui.color("Remote node responded after #{elapsed_time_in_minutes(wait_start_time)} minutes.", :magenta))
-          return
-        rescue Errno::ECONNREFUSED => e
-          ui.error("Connection refused connecting to #{locate_config_value(:server_name)}:#{locate_config_value(:winrm_port)}.")
-          raise
-        rescue Exception => e
-          retries_left -= 1
-          if retries_left <= 0 || (elapsed_time_in_minutes(wait_start_time) > wait_max_minutes)
-            ui.error("No response received from remote node after #{elapsed_time_in_minutes(wait_start_time)} minutes, giving up.")
-            ui.error("Exception: #{e.message}")
-            raise
-          end
-          print '.'
-          sleep retry_interval_seconds
-          retry
-        end
-      end
-
-      def elapsed_time_in_minutes(start_time)
-        ((Time.now - start_time) / 60).round(2)
-      end
     end
   end
 end

data/lib/chef/knife/windows_helper.rb

@@ -33,4 +33,3 @@ class Chef
     end
   end
 end
-