knife-windows 0.5.2 → 0.5.3

data/README.rdoc

@@ -2,7 +2,7 @@
 
 = DESCRIPTION:
 
-This plugins adds additional functionality to the Chef Knife CLI tool for configuring/interacting with nodes running Microsoft Windows.  The subcommands should function on any system running Ruby 1.9.1+ but nodes being configured via these subcommands require Windows Remote Management (WinRM) 1.0+.  WinRM allows you to call native objects in Windows.  This includes, but is not limited to, running batch scripts, powershell scripts and fetching WMI variables.  For more information on WinRM, please visit {Microsoft's WinRM site}[http://msdn.microsoft.com/en-us/library/aa384426(v=VS.85).aspx]. You will want to familiarize yourself with (certain key aspects) of WinRM because you will be {writing scripts/running commands} with this tool to get you from (specific point A) to (specific point B).
+This plugin adds additional functionality to the Chef Knife CLI tool for configuring/interacting with nodes running Microsoft Windows.  The subcommands should function on any system running Ruby 1.9.1+ but nodes being configured via these subcommands require Windows Remote Management (WinRM) 1.0+.  WinRM allows you to call native objects in Windows.  This includes, but is not limited to, running batch scripts, powershell scripts and fetching WMI variables.  For more information on WinRM, please visit {Microsoft's WinRM site}[http://msdn.microsoft.com/en-us/library/aa384426(v=VS.85).aspx]. You will want to familiarize yourself with (certain key aspects) of WinRM because you will be {writing scripts/running commands} with this tool to get you from (specific point A) to (specific point B).
 
 WinRM is built into Windows 7 and Windows Server 2008+.  It can also be easily installed in older version of Windows, including:
 
@@ -12,6 +12,8 @@ WinRM is built into Windows 7 and Windows Server 2008+.  It can also be easily i
 
 More information can be found on {Microsoft Support article 968930}[http://support.microsoft.com/?kbid=968930].
 
+This subcommands in this plugin have been tested and verified to work on Windows Server 2008 R2.
+
 = SUBCOMMANDS:
 
 This plugin provides the following Knife subcommands.  Specific command options can be found by invoking the subcommand with a --+help+ flag
@@ -34,13 +36,23 @@ Or force a chef run:
 
 This subcommand operates in a very similar manner as {knife ssh}[http://wiki.opscode.com/display/chef/Knife#Knife-SSHSubcommand]...just leveraging the WinRM protocol for communication.  It also include's +knife+ +ssh+'s "{interactive session mode}[http://wiki.opscode.com/display/chef/Knife#Knife-InteractiveMode]"
 
-== knife winrm bootstrap
+== knife bootstrap windows winrm
 
 Performs a Chef Bootstrap (via the WinRM protocol) on the target node. The goal of the bootstrap is to get Chef installed on the target system so it can run Chef Client with a Chef Server. The main assumption is a baseline OS installation exists. It is primarily intended for Chef Client systems that talk to a Chef server. 
 
-In the future this subcommand will be used internally by some cloud computing server create commands like the current *knife bootstrap* subcommand is. This subcommand operates in a very similar manner as {knife bootstrap}[http://wiki.opscode.com/display/chef/Knife+Bootstrap]...just leveraging the WinRM protocol for communication.  An initial run_list for the node can also be passed to the subcommand. Example usage:
+This subcommand operates in a very similar manner as {knife bootstrap}[http://wiki.opscode.com/display/chef/Knife+Bootstrap]...just leveraging the WinRM protocol for communication.  An initial run_list for the node can also be passed to the subcommand. Example usage:
+
+    knife bootstrap windows winrm ec2-50-xx-xx-124.compute-1.amazonaws.com -r 'role[webserver],role[production]' -x Administrator -P 'super_secret_password'
+
+== knife bootstrap windows ssh
+
+Performs a Chef Bootstrap (via the SSH protocol) on the target node. The goal of the bootstrap is to get Chef installed on the target system so it can run Chef Client with a Chef Server. The main assumption is a baseline OS installation exists. It is primarily intended for Chef Client systems that talk to a Chef server. 
+
+This subcommand assumes the SSH session will use Windows native cmd.exe command shell vs a bash shell through an emulated cygwin layer.  Most popular Windows based SSHd daemons like {freeSSHd}[http://www.freesshd.com/] and {WinSSHD}[http://www.bitvise.com/winsshd] behave this way.
+
+An initial run_list for the node can also be passed to the subcommand. Example usage:
 
-    knife winrm bootstrap ec2-50-xx-xx-124.compute-1.amazonaws.com -r 'role[webserver]','role[production]' -x Administrator -P 'super_secret_password'
+    knife bootstrap windows ssh ec2-50-xx-xx-124.compute-1.amazonaws.com -r 'role[webserver],role[production]' -x Administrator -i ~/.ssh/id_rsa
 
 = BOOTSTRAP TEMPLATES:
 
@@ -51,13 +63,14 @@ This gem provides the following bootstrap templates:
 This bootstrap template does the following:
 
 * Installs Ruby 1.8.7 via the {Ruby Installer for Windows}[http://rubyinstaller.org/] which also includes the latest version of RubyGems
+* Installs the RubyInstaller Development Kit (DevKit). The RubyInstaller Development Kit (DevKit) is a MSYS/MinGW based toolkit than enables you to build many of the native C/C++ extensions available for Ruby.
 * Installs required Windows-related gems from RubyGems.org
-* Installs latest Chef version from RubyGems.org including {Ohai}[https://rubygems.org/gems/ohai] and {Chef}[https://rubygems.org/gems/chef].
+* Installs latest Chef version from RubyGems.org including {Ohai}[https://rubygems.org/gems/ohai] and {Chef}[https://rubygems.org/gems/chef]. The Chef version is configurable using the *--bootstrap-version* option.
 * Writes the validation.pem per the local knife configuration.
 * Writes a default config file for Chef (C:\chef\client.rb) using values from the +knife.rb+.
 * Creates a JSON attributes file containing the specified run list and run Chef.
 
-This is the default bootstrap template used by the +winrm+ +bootstrap+ subcommand.
+This is the default bootstrap template used by both the +windows+ +bootstrap+ subcommands.
 
 = REQUIREMENTS/SETUP:
 

data/lib/chef/knife/bootstrap/windows-shell.erb

@@ -16,6 +16,7 @@
 @rem limitations under the License.
 @rem
 
+<%= "SETX HTTP_PROXY \"#{knife_config[:bootstrap_proxy]}\"" if knife_config[:bootstrap_proxy] %>
 mkdir C:\chef
 
 > C:\chef\wget.vbs (

data/lib/chef/knife/bootstrap_windows_ssh.rb

@@ -0,0 +1,123 @@
+#
+# Author:: Seth Chisamore (<schisamo@opscode.com>)
+# Copyright:: Copyright (c) 2011 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 File.join(File.dirname(__FILE__), 'mixin/windows/bootstrap')
+
+class Chef
+  class Knife
+    class BootstrapWindowsSsh < Bootstrap
+
+      include Chef::Mixin::Bootstrap
+
+      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
+      end
+
+      banner "knife bootstrap windows ssh FQDN (options)"
+
+      option :ssh_user,
+        :short => "-x USERNAME",
+        :long => "--ssh-user USERNAME",
+        :description => "The ssh username",
+        :default => "root"
+
+      option :ssh_password,
+        :short => "-P PASSWORD",
+        :long => "--ssh-password PASSWORD",
+        :description => "The ssh password"
+
+      option :ssh_port,
+        :short => "-p PORT",
+        :long => "--ssh-port PORT",
+        :description => "The ssh port",
+        :default => "22",
+        :proc => Proc.new { |key| Chef::Config[:knife][:ssh_port] = key }
+
+      option :identity_file,
+        :short => "-i IDENTITY_FILE",
+        :long => "--identity-file IDENTITY_FILE",
+        :description => "The SSH identity file used for authentication"
+
+      option :chef_node_name,
+        :short => "-N NAME",
+        :long => "--node-name NAME",
+        :description => "The Chef node name for your new node"
+
+      option :prerelease,
+        :long => "--prerelease",
+        :description => "Install the pre-release chef gems"
+
+      option :bootstrap_version,
+        :long => "--bootstrap-version VERSION",
+        :description => "The version of Chef to install",
+        :proc => Proc.new { |v| Chef::Config[:knife][:bootstrap_version] = v }
+
+      option :bootstrap_proxy,
+        :long => "--bootstrap-proxy PROXY_URL",
+        :description => "The proxy server for the node being bootstrapped",
+        :proc => Proc.new { |p| Chef::Config[:knife][:bootstrap_proxy] = p }
+
+      option :distro,
+        :short => "-d DISTRO",
+        :long => "--distro DISTRO",
+        :description => "Bootstrap a distro using a template",
+        :default => "windows-shell"
+
+      option :template_file,
+        :long => "--template-file TEMPLATE",
+        :description => "Full path to location of template to use",
+        :default => false
+
+      option :run_list,
+        :short => "-r RUN_LIST",
+        :long => "--run-list RUN_LIST",
+        :description => "Comma separated list of roles/recipes to apply",
+        :proc => lambda { |o| o.split(",") },
+        :default => []
+
+      option :no_host_key_verify,
+        :long => "--no-host-key-verify",
+        :description => "Disable host key verification",
+        :boolean => true,
+        :default => false
+
+      def run
+        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[:identity_file] = config[:identity_file]
+        ssh.config[:manual] = true
+        ssh.config[:no_host_key_verify] = config[:no_host_key_verify]
+        ssh
+      end
+
+    end
+  end
+end

data/lib/chef/knife/{winrm_bootstrap.rb → bootstrap_windows_winrm.rb}

@@ -16,21 +16,22 @@
 # limitations under the License.
 #
 
-require 'chef/knife'
-require 'erubis'
+require File.join(File.dirname(__FILE__), 'mixin/windows/bootstrap')
 
 class Chef
   class Knife
-    class WinrmBootstrap < Bootstrap
+    class BootstrapWindowsWinrm < Bootstrap
+
+      include Chef::Mixin::Bootstrap
 
       deps do
         require 'chef/knife/core/windows_bootstrap_context'
         require 'chef/json_compat'
         require 'tempfile'
-         Chef::Knife::Winrm.load_deps
+        Chef::Knife::Winrm.load_deps
       end
 
-      banner "knife winrm bootstrap FQDN (options)"
+      banner "knife bootstrap windows winrm FQDN (options)"
 
       option :winrm_user,
         :short => "-x USERNAME",
@@ -48,14 +49,19 @@ class Chef
       option :winrm_port,
         :short => "-p PORT",
         :long => "--winrm-port PORT",
-        :description => "The WinRM port",
+        :description => "The WinRM port, by default this is 5985",
         :default => "5985",
         :proc => Proc.new { |key| Chef::Config[:knife][:winrm_port] = key }
 
+      option :identity_file,
+        :short => "-i IDENTITY_FILE",
+        :long => "--identity-file IDENTITY_FILE",
+        :description => "The SSH identity file used for authentication"
+
       option :winrm_transport,
         :short => "-t TRANSPORT",
         :long => "--winrm-transport TRANSPORT",
-        :description => "The WinRM transport type: ssl, or plaintext",
+        :description => "The WinRM transport type.  valid choices are [ssl, plaintext]",
         :default => 'plaintext',
         :proc => Proc.new { |transport| Chef::Config[:knife][:winrm_transport] = transport }
 
@@ -97,6 +103,11 @@ class Chef
         :description => "The version of Chef to install",
         :proc => Proc.new { |v| Chef::Config[:knife][:bootstrap_version] = v }
 
+      option :bootstrap_proxy,
+        :long => "--bootstrap-proxy PROXY_URL",
+        :description => "The proxy server for the node being bootstrapped",
+        :proc => Proc.new { |p| Chef::Config[:knife][:bootstrap_proxy] = p }
+
       option :distro,
         :short => "-d DISTRO",
         :long => "--distro DISTRO",
@@ -115,110 +126,25 @@ class Chef
         :proc => lambda { |o| o.split(",") },
         :default => []
 
-      # TODO: This should go away when CHEF-2193 is fixed
-      def load_template(template=nil)
-        # Are we bootstrapping using an already shipped template?
-        if config[:template_file]
-          bootstrap_files = config[:template_file]
-        else
-          bootstrap_files = []
-          bootstrap_files << File.join(File.dirname(__FILE__), 'bootstrap', "#{config[:distro]}.erb")
-          bootstrap_files << File.join(Dir.pwd, ".chef", "bootstrap", "#{config[:distro]}.erb")
-          bootstrap_files << File.join(ENV['HOME'], '.chef', 'bootstrap', "#{config[:distro]}.erb")
-          bootstrap_files << Gem.find_files(File.join("chef","knife","bootstrap","#{config[:distro]}.erb"))
-        end
-
-        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 render_template(template=nil)
-        context = Knife::Core::WindowsBootstrapContext.new(config, config[:run_list], Chef::Config)
-        Erubis::Eruby.new(template).evaluate(context)
-      end
-
       def run
-
-        validate_name_args!
-
-        @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)}")
-        # 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, chunk_num|
-          knife_winrm("echo \"Rendering bootstrap.bat chunk #{chunk_num}\" && #{command_chunk}").run
-        end
-
-        # execute the bootstrap.bat file
-        knife_winrm(bootstrap_command).run
+        bootstrap
       end
 
-      # def validate_name_args!
-      #   if Array(@name_args).first.nil?
-      #     ui.error("Must pass an FQDN or ip to bootstrap")
-      #     exit 1
-      #   end
-      # end
-      # 
-      # def server_name
-      #   Array(@name_args).first
-      # end
-
-      def knife_winrm(command = '')
+      def run_command(command = '')
         winrm = Chef::Knife::Winrm.new
         winrm.name_args = [ server_name, command ]
-        winrm.config[:winrm_user] = Chef::Config[:knife][:winrm_user] || config[:winrm_user]
-        winrm.config[:winrm_password] = Chef::Config[:knife][:winrm_password] if config[:winrm_password]
-        winrm.config[:winrm_transport] = Chef::Config[:knife][:winrm_transport] || config[:winrm_transport]
+        winrm.config[:winrm_user] = locate_config_value(:winrm_user)
+        winrm.config[:winrm_password] = locate_config_value(:winrm_password)
+        winrm.config[:winrm_transport] = locate_config_value(:winrm_transport)
         winrm.config[:kerberos_keytab_file] = Chef::Config[:knife][:kerberos_keytab_file] if Chef::Config[:knife][:kerberos_keytab_file]
         winrm.config[:kerberos_realm] = Chef::Config[:knife][:kerberos_realm] if Chef::Config[:knife][:kerberos_realm]
         winrm.config[:kerberos_service] = Chef::Config[:knife][:kerberos_service] if Chef::Config[:knife][:kerberos_service]
         winrm.config[:ca_trust_file] = Chef::Config[:knife][:ca_trust_file] if Chef::Config[:knife][:ca_trust_file]
         winrm.config[:manual] = true
-        winrm.config[:winrm_port] = Chef::Config[:knife][:winrm_port] || config[:winrm_port]
+        winrm.config[:winrm_port] = locate_config_value(:winrm_port)
         winrm
       end
 
-      def bootstrap_command
-        @bootstrap_command ||= "cmd /C #{bootstrap_bat_file}"
-      end
-
-      def create_bootstrap_bat_command(&block)
-        bootstrap_bat = []
-        chunk_num = 0
-        render_template(load_template(config[:bootstrap_template])).each_line do |line|
-          # escape WIN BATCH special chars
-          line.gsub!(/[(<|>)^]/).each{|m| "^#{m}"}
-          # windows commands are limited to 2047 characters
-          if((bootstrap_bat + [line]).join(" && ").size > 2047 )
-            yield bootstrap_bat.join(" && "), chunk_num += 1
-            bootstrap_bat = []
-          end
-          bootstrap_bat << ">> #{bootstrap_bat_file} (echo.#{line.chomp.strip})"
-        end
-        yield bootstrap_bat.join(" && "), chunk_num += 1
-      end
-
-      def bootstrap_bat_file
-        "%TEMP%\\bootstrap.bat"
-      end
-
     end
   end
 end

data/lib/chef/knife/core/windows_bootstrap_context.rb

@@ -60,6 +60,13 @@ CONFIG
           else
             client_rb << "# Using default node name (fqdn)\n"
           end
+          
+          if knife_config[:bootstrap_proxy]
+            client_rb << "\n"
+            client_rb << %Q{http_proxy        "#{knife_config[:bootstrap_proxy]}"\n}
+            client_rb << %Q{https_proxy       "#{knife_config[:bootstrap_proxy]}"\n}
+          end
+          
           escape_and_echo(client_rb)
         end
 
@@ -75,11 +82,24 @@ CONFIG
           win_wget = <<-WGET
 url = WScript.Arguments.Named("url")
 path = WScript.Arguments.Named("path")
-Set objXMLHTTP = CreateObject("MSXML2.ServerXMLHTTP")
-'proxy is optional
+Set objXMLHTTP = CreateObject("MSXML2.ServerXMLHTTP.6.0")
+Set wshShell = CreateObject( "WScript.Shell" )
+Set objUserVariables = wshShell.Environment("USER")
+
+'http proxy is optional
+'attempt to read from HTTP_PROXY env var first
 On Error Resume Next
+
+If NOT (objUserVariables("HTTP_PROXY") = "") Then
+objXMLHTTP.setProxy 2, objUserVariables("HTTP_PROXY")
+
+'fall back to named arg
+ElseIf NOT (WScript.Arguments.Named("proxy") = "") Then
 objXMLHTTP.setProxy 2, WScript.Arguments.Named("proxy")
+End If
+
 On Error Goto 0
+
 objXMLHTTP.open "GET", url, false
 objXMLHTTP.send()
 If objXMLHTTP.Status = 200 Then

data/lib/chef/knife/mixin/windows/bootstrap.rb

@@ -0,0 +1,94 @@
+require 'chef/knife'
+require 'erubis'
+
+class Chef
+  module Mixin
+    module Bootstrap
+
+      # TODO: This should go away when CHEF-2193 is fixed
+      def load_template(template=nil)
+        # Are we bootstrapping using an already shipped template?
+        if config[:template_file]
+          bootstrap_files = config[:template_file]
+        else
+          bootstrap_files = []
+          bootstrap_files << File.join(File.dirname(__FILE__), 'bootstrap', "#{config[:distro]}.erb")
+          bootstrap_files << File.join(Dir.pwd, ".chef", "bootstrap", "#{config[:distro]}.erb")
+          bootstrap_files << File.join(ENV['HOME'], '.chef', 'bootstrap', "#{config[:distro]}.erb")
+          bootstrap_files << Gem.find_files(File.join("chef","knife","bootstrap","#{config[:distro]}.erb"))
+          bootstrap_files.flatten!
+        end
+
+        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 render_template(template=nil)
+        context = Knife::Core::WindowsBootstrapContext.new(config, config[:run_list], Chef::Config)
+        Erubis::Eruby.new(template).evaluate(context)
+      end
+
+      def bootstrap(proto=nil)
+
+        validate_name_args!
+
+        @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)}")
+        # 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, chunk_num|
+          run_command("cmd.exe /C echo \"Rendering bootstrap.bat chunk #{chunk_num}\" && #{command_chunk}").run
+        end
+
+        # execute the bootstrap.bat file
+        run_command(bootstrap_command).run
+      end
+
+      def bootstrap_command
+        @bootstrap_command ||= "cmd.exe /C #{bootstrap_bat_file}"
+      end
+
+      def create_bootstrap_bat_command(&block)
+        bootstrap_bat = []
+        chunk_num = 0
+        render_template(load_template(config[:bootstrap_template])).each_line do |line|
+          # escape WIN BATCH special chars
+          line.gsub!(/[(<|>)^]/).each{|m| "^#{m}"}
+          # windows commands are limited to 2047 characters
+          if((bootstrap_bat + [line]).join(" && ").size > 2047 )
+            yield bootstrap_bat.join(" && "), chunk_num += 1
+            bootstrap_bat = []
+          end
+          bootstrap_bat << ">> #{bootstrap_bat_file} (echo.#{line.chomp.strip})"
+        end
+        yield bootstrap_bat.join(" && "), chunk_num += 1
+      end
+
+      def bootstrap_bat_file
+        "%TEMP%\\bootstrap.bat"
+      end
+
+      def locate_config_value(key)
+        key = key.to_sym
+        Chef::Config[:knife][key] || config[key]
+      end
+
+    end
+  end
+end

data/lib/knife-windows/version.rb

@@ -1,6 +1,6 @@
 module Knife
   module Windows
-    VERSION = "0.5.2"
+    VERSION = "0.5.3"
     MAJOR, MINOR, TINY = VERSION.split('.')
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: knife-windows
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors: 
 - Seth Chisamore
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-02 00:00:00 -04:00
+date: 2011-05-13 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,9 +42,11 @@ files:
 - Rakefile
 - knife-windows.gemspec
 - lib/chef/knife/bootstrap/windows-shell.erb
+- lib/chef/knife/bootstrap_windows_ssh.rb
+- lib/chef/knife/bootstrap_windows_winrm.rb
 - lib/chef/knife/core/windows_bootstrap_context.rb
+- lib/chef/knife/mixin/windows/bootstrap.rb
 - lib/chef/knife/winrm.rb
-- lib/chef/knife/winrm_bootstrap.rb
 - lib/knife-windows/version.rb
 has_rdoc: true
 homepage: https://github.com/opscode/knife-windows