knife-openstack 0.7.1 → 0.8.0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.8.0
+
+* Windows bootstrapping (winrm-based) support for knife-openstack (KNIFE-221)(Chirag Jog)
+
 ## v0.7.1
 
 * file permissions fixed (KNIFE-261)

data/README.md

@@ -1,7 +1,7 @@
 Knife OpenStack
 ===============
 
-This is the official Opscode Knife plugin for OpenStack Compute (Nova). This plugin gives knife the ability to create, bootstrap and manage instances in OpenStack Compute clouds. It has been tested against the `Diablo` through pre-`Grizzly` releases in configurations using Keystone against the OpenStack API (as opposed to the EC2 API).
+This is the official Opscode Knife plugin for OpenStack Compute (Nova). This plugin gives knife the ability to create, bootstrap and manage instances in OpenStack Compute clouds. It has been tested against the `Diablo` through `Grizzly` releases in configurations using Keystone against the OpenStack API (as opposed to the EC2 API).
 
 Please refer to the [CHANGELOG](CHANGELOG.md) for version history and known issues.
 
@@ -54,6 +54,19 @@ Additionally the following options may be set in your `knife.rb`:
 
 To use a floating IP address while bootstrapping nodes, use the `-a` or `--floating-ip` option. For the node to have the floating IP address after bootstrapping, it is required to use the new `openstack.rb` Ohai plugin, waiting for the next Ohai release or installed using the [ohai cookbook](https://github.com/opscode-cookbooks/ohai). https://github.com/mattray/ohai/tree/OHAI-381 is the ticket for this.
 
+# Working with Windows Images #
+
+Provisioning and bootstrapping for Windows 2003/2008 images is now supported. The Windows images need to have WinRM enabled with Basic Authentication configured. Current support does not support Kerberos Authentication.
+
+Example:
+
+    knife openstack server create -I <Image_ID> -f <Flavor_ID> -S <keypair_name> --bootstrap-protocol winrm -P <Administrator_Password> -x Administrator -N <chef_node_name> --template windows-chef-client-msi.erb
+
+NOTE:
+* Bootstrap Protocol (`--bootstrap-protocol`) is required to be set to `winrm`.
+* Administrator Username (`--winrm-user` or `-x`) and Password (`-P`) are required parameters.
+* If the Template File (`--template`) is not specified it defaults to a Linux distro (most likely Ubuntu).
+
 # Subcommands #
 
 This plugin provides the following Knife subcommands. Specific command options can be found by invoking the subcommand with a `--help` option.
@@ -94,6 +107,8 @@ Author:: Seth Chisamore (<schisamo@opscode.com>)
 
 Author:: Matt Ray (<matt@opscode.com>)
 
+Author:: Chirag Jog (<chirag@clogeny.com>)
+
 Copyright:: Copyright (c) 2011-2013 Opscode, Inc.
 
 License:: Apache License, Version 2.0

data/knife-openstack.gemspec

@@ -21,4 +21,8 @@ Gem::Specification.new do |s|
 
   s.add_dependency "fog", ">= 1.10.0"
   s.add_dependency "chef", ">= 0.10.10"
+  s.add_dependency "knife-windows"
+  
+  %w(rspec-core rspec-expectations rspec-mocks rspec_junit_formatter).each { |gem| s.add_development_dependency gem }
+  s.require_paths = ["lib"]
 end

data/lib/chef/knife/openstack_server_create.rb

@@ -1,6 +1,7 @@
 #
 # Author:: Seth Chisamore (<schisamo@opscode.com>)
 # Author:: Matt Ray (<matt@opscode.com>)
+# Author:: Chirag Jog (<chirag@clogeny.com>)
 # Copyright:: Copyright (c) 2011-2013 Opscode, Inc.
 # License:: Apache License, Version 2.0
 #
@@ -18,12 +19,14 @@
 #
 
 require 'chef/knife/openstack_base'
+require 'chef/knife/winrm_base'
 
 class Chef
   class Knife
     class OpenstackServerCreate < Knife
 
       include Knife::OpenstackBase
+      include Chef::Knife::WinrmBase
 
       deps do
         require 'fog'
@@ -130,6 +133,22 @@ class Chef
       :boolean => true,
       :default => true
 
+      option :bootstrap_protocol,
+      :long => "--bootstrap-protocol protocol",
+      :description => "Protocol to bootstrap Windows servers. options: winrm",
+      :default => nil
+
+      option :bootstrap_proxy,
+      :long => "--bootstrap-proxy PROXY_URL",
+      :description => "The proxy server for the node being bootstrapped",
+      :proc => Proc.new { |v| Chef::Config[:knife][:bootstrap_proxy] = v }
+
+      option :server_create_timeout,
+      :long => "--server-create-timeout timeout",
+      :description => "How long to wait until the server is ready; default is 600 seconds",
+      :default => 600,
+      :proc => Proc.new { |v| Chef::Config[:knife][:server_create_timeouts] = v}
+
       def tcp_test_ssh(hostname)
         tcp_socket = TCPSocket.new(hostname, 22)
         readable = IO.select([tcp_socket], nil, nil, 5)
@@ -157,11 +176,41 @@ class Chef
         tcp_socket && tcp_socket.close
       end
 
+      def tcp_test_winrm(hostname, port)
+        TCPSocket.new(hostname, port)
+        return true
+      rescue SocketError
+        sleep 2
+        false
+      rescue Errno::ETIMEDOUT
+        false
+      rescue Errno::EPERM
+        false
+      rescue Errno::ECONNREFUSED
+        sleep 2
+        false
+      rescue Errno::EHOSTUNREACH
+        sleep 2
+        false
+      rescue Errno::ENETUNREACH
+        sleep 2
+        false
+      end
+
+      def load_winrm_deps
+        require 'winrm'
+        require 'em-winrm'
+        require 'chef/knife/bootstrap_windows_winrm'
+        require 'chef/knife/core/windows_bootstrap_context'
+        require 'chef/knife/winrm'
+      end
       def run
         $stdout.sync = true
 
         validate!
-
+        if locate_config_value(:bootstrap_protocol) == 'winrm'
+          load_winrm_deps
+        end
         #servers require a name, generate one if not passed
         node_name = get_node_name(config[:chef_node_name])
 
@@ -204,7 +253,7 @@ class Chef
       print "\n#{ui.color("Waiting for server", :magenta)}"
 
       # wait for it to be ready to do stuff
-      server.wait_for { print "."; ready? }
+      server.wait_for(Integer(locate_config_value(:server_create_timeout))) { print "."; ready? }
 
       puts("\n")
 
@@ -253,15 +302,18 @@ class Chef
         exit 1
       end
 
-      print "\n#{ui.color("Waiting for sshd", :magenta)}"
-
-      print(".") until tcp_test_ssh(bootstrap_ip_address) {
-        sleep @initial_sleep_delay ||= 10
-        puts("done")
-      }
-
-      bootstrap_for_node(server, bootstrap_ip_address).run
-
+      if locate_config_value(:bootstrap_protocol) == 'winrm'
+        print "\n#{ui.color("Waiting for winrm", :magenta)}"
+        print(".") until tcp_test_winrm(bootstrap_ip_address, locate_config_value(:winrm_port))
+        bootstrap_for_windows_node(server, bootstrap_ip_address).run
+      else
+        print "\n#{ui.color("Waiting for sshd", :magenta)}"
+        print(".") until tcp_test_ssh(bootstrap_ip_address) {
+          sleep @initial_sleep_delay ||= 10
+          puts("done")
+        }
+        bootstrap_for_node(server, bootstrap_ip_address).run
+      end
       puts "\n"
       msg_pair("Instance Name", server.name)
       msg_pair("Instance ID", server.id)
@@ -275,27 +327,43 @@ class Chef
       msg_pair("Run List", config[:run_list].join(', '))
     end
 
-    def bootstrap_for_node(server, bootstrap_ip_address)
-      bootstrap = Chef::Knife::Bootstrap.new
+    def bootstrap_for_windows_node(server, bootstrap_ip_address)
+      bootstrap = Chef::Knife::BootstrapWindowsWinrm.new
       bootstrap.name_args = [bootstrap_ip_address]
+      bootstrap.config[:winrm_user] = locate_config_value(:winrm_user) || 'Administrator'
+      bootstrap.config[:winrm_password] = locate_config_value(:winrm_password)
+      bootstrap.config[:winrm_transport] = locate_config_value(:winrm_transport)
+      bootstrap.config[:winrm_port] = locate_config_value(:winrm_port)
+      bootstrap_common_params(bootstrap, server.name)
+    end
+
+    def bootstrap_common_params(bootstrap, server_name)
+      bootstrap.config[:chef_node_name] = config[:chef_node_name] || server_name
       bootstrap.config[:run_list] = config[:run_list]
-      bootstrap.config[:ssh_user] = config[:ssh_user]
-      bootstrap.config[:ssh_password] = server.password
-      bootstrap.config[:identity_file] = config[:identity_file]
-      bootstrap.config[:host_key_verify] = config[:host_key_verify]
-      bootstrap.config[:chef_node_name] = server.name
       bootstrap.config[:prerelease] = config[:prerelease]
       bootstrap.config[:bootstrap_version] = locate_config_value(:bootstrap_version)
       bootstrap.config[:distro] = locate_config_value(:distro)
-      bootstrap.config[:use_sudo] = true unless config[:ssh_user] == 'root'
       bootstrap.config[:template_file] = locate_config_value(:template_file)
+      bootstrap.config[:bootstrap_proxy] = locate_config_value(:bootstrap_proxy)
       bootstrap.config[:environment] = config[:environment]
+      bootstrap.config[:encrypted_data_bag_secret] = config[:encrypted_data_bag_secret]
+      bootstrap.config[:encrypted_data_bag_secret_file] = config[:encrypted_data_bag_secret_file]
       # let ohai know we're using OpenStack
       Chef::Config[:knife][:hints] ||= {}
       Chef::Config[:knife][:hints]['openstack'] ||= {}
       bootstrap
     end
 
+    def bootstrap_for_node(server, bootstrap_ip_address)
+      bootstrap = Chef::Knife::Bootstrap.new
+      bootstrap.name_args = [bootstrap_ip_address]
+      bootstrap.config[:ssh_user] = config[:ssh_user]
+      bootstrap.config[:identity_file] = config[:identity_file]
+      bootstrap.config[:host_key_verify] = config[:host_key_verify]
+      bootstrap.config[:use_sudo] = true unless config[:ssh_user] == 'root'
+      bootstrap_common_params(bootstrap, server.name)
+    end
+
     def flavor
       @flavor ||= connection.flavors.get(locate_config_value(:flavor))
     end

data/lib/knife-openstack/version.rb

@@ -1,6 +1,6 @@
 module Knife
   module OpenStack
-    VERSION = "0.7.1"
+    VERSION = "0.8.0"
     MAJOR, MINOR, TINY = VERSION.split('.')
   end
 end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'chef/knife/bootstrap'
+require 'chef/knife/winrm_base'
+require 'chef/knife/openstack_server_create'

data/spec/unit/openstack_server_create_spec.rb

@@ -0,0 +1,164 @@
+#
+# Author:: Mukta Aphale (<mukta.aphale@clogeny.com>)
+# Copyright:: Copyright (c) 2013 Opscode, Inc.
+
+require File.expand_path('../../spec_helper', __FILE__)
+require 'fog'
+require 'chef/knife/bootstrap'
+require 'chef/knife/bootstrap_windows_winrm'
+
+describe Chef::Knife::OpenstackServerCreate do
+  before do
+
+    @openstack_connection = mock(Fog::Compute::OpenStack)
+    @openstack_connection.stub_chain(:flavors, :get).and_return ('flavor_id')
+    @openstack_connection.stub_chain(:images, :get).and_return mock('image_id')
+    @openstack_connection.stub_chain(:addresses).and_return [mock('addresses', {
+            :instance_id => nil,
+            :ip => '111.111.111.111',
+            :fixed_ip => true
+            })]
+
+    @knife_openstack_create = Chef::Knife::OpenstackServerCreate.new
+    @knife_openstack_create.initial_sleep_delay = 0
+    @knife_openstack_create.stub(:tcp_test_ssh).and_return(true)
+    @knife_openstack_create.stub(:tcp_test_winrm).and_return(true)
+
+    {
+      :image => 'image',
+      :openstack_username => 'openstack_username',
+      :openstack_password => 'openstack_password',
+      :openstack_auth_url => 'openstack_auth_url',
+      :server_create_timeout => 1000
+    }.each do |key, value|
+      Chef::Config[:knife][key] = value
+    end
+
+    @knife_openstack_create.stub(:msg_pair)
+    @knife_openstack_create.stub(:puts)
+    @knife_openstack_create.stub(:print)
+
+
+    @openstack_servers = mock()
+    @new_openstack_server = mock()
+
+    @openstack_server_attribs = { :name => 'Mock Server',
+                                  :id => 'id-123456',
+                                  :key_name => 'key_name',
+                                  :flavor => 'flavor_id',
+                                  :image => 'image_id',
+                                  :addresses => {
+                                    'public' => [{'addr' => '75.101.253.10'}],
+                                    'private' => [{'addr' => '10.251.75.20'}]
+                                    },
+                                  :password => 'password'
+                                }
+
+
+    @openstack_server_attribs.each_pair do |attrib, value|
+      @new_openstack_server.stub(attrib).and_return(value)
+    end
+  end
+
+  describe "run" do
+    before do
+      @openstack_servers.should_receive(:create).and_return(@new_openstack_server)
+      @openstack_connection.should_receive(:servers).and_return(@openstack_servers)
+      Fog::Compute::OpenStack.should_receive(:new).and_return(@openstack_connection)
+      @bootstrap = Chef::Knife::Bootstrap.new
+      Chef::Knife::Bootstrap.stub(:new).and_return(@bootstrap)
+      @bootstrap.should_receive(:run)
+      @knife_openstack_create.config[:run_list] = []
+      @knife_openstack_create.config[:floating_ip] = '-1'
+    end
+
+    it "Creates an OpenStack instance and bootstraps it" do
+      @new_openstack_server.should_receive(:wait_for).and_return(true)
+      @knife_openstack_create.run
+    end
+
+    it "Creates an OpenStack instance for Windows and bootstraps it" do
+      @bootstrap_win = Chef::Knife::BootstrapWindowsWinrm.new
+      Chef::Knife::BootstrapWindowsWinrm.stub(:new).and_return(@bootstrap_win)
+      Chef::Config[:knife][:bootstrap_protocol] = 'winrm'
+      @new_openstack_server.should_receive(:wait_for).and_return(true)
+      @knife_openstack_create.run
+    end
+
+    it "creates an OpenStack instance, assigns existing floating ip and bootstraps it" do
+      @knife_openstack_create.config[:floating_ip] = "111.111.111.111"
+      @new_openstack_server.should_receive(:wait_for).and_return(true)
+      @new_openstack_server.should_receive(:associate_address).with('111.111.111.111')
+      @knife_openstack_create.run
+    end
+  end
+
+  describe "when configuring the bootstrap process" do
+    before do
+      @knife_openstack_create.config[:ssh_user] = "ubuntu"
+      @knife_openstack_create.config[:identity_file] = "~/.ssh/key.pem"
+      @knife_openstack_create.config[:chef_node_name] = "blarf"
+      @knife_openstack_create.config[:template_file] = '~/.chef/templates/my-bootstrap.sh.erb'
+      @knife_openstack_create.config[:distro] = 'ubuntu-10.04-magic-sparkles'
+      @knife_openstack_create.config[:run_list] = ['role[base]']
+
+      @bootstrap = @knife_openstack_create.bootstrap_for_node(@new_openstack_server,
+        @new_openstack_server.addresses['public'].last['addr'])
+    end
+
+    it "should set the bootstrap 'name argument' to the hostname of the OpenStack server" do
+      @bootstrap.name_args.should == ['75.101.253.10']
+    end
+
+    it "configures sets the bootstrap's run_list" do
+      @bootstrap.config[:run_list].should == ['role[base]']
+    end
+
+    it "configures the bootstrap to use the correct ssh_user login" do
+      @bootstrap.config[:ssh_user].should == 'ubuntu'
+    end
+
+    it "configures the bootstrap to use the correct ssh identity file" do
+      @bootstrap.config[:identity_file].should == "~/.ssh/key.pem"
+    end
+
+    it "configures the bootstrap to use the configured node name if provided" do
+      @bootstrap.config[:chef_node_name].should == 'blarf'
+    end
+
+    it "configures the bootstrap to use the OpenStack server id if no explicit node name is set" do
+      @knife_openstack_create.config[:chef_node_name] = nil
+
+      bootstrap = @knife_openstack_create.bootstrap_for_node(@new_openstack_server,
+        @new_openstack_server.addresses['public'].last['addr'])
+      bootstrap.config[:chef_node_name].should == @new_openstack_server.name
+    end
+
+    it "configures the bootstrap to use prerelease versions of chef if specified" do
+      @bootstrap.config[:prerelease].should be_false
+
+      @knife_openstack_create.config[:prerelease] = true
+
+      bootstrap = @knife_openstack_create.bootstrap_for_node(@new_openstack_server,
+        @new_openstack_server.addresses['public'].last['addr'])
+      bootstrap.config[:prerelease].should be_true
+    end
+
+    it "configures the bootstrap to use the desired distro-specific bootstrap script" do
+      @bootstrap.config[:distro].should == 'ubuntu-10.04-magic-sparkles'
+    end
+
+    it "configures the bootstrap to use sudo" do
+      @bootstrap.config[:use_sudo].should be_true
+    end
+
+    it "configured the bootstrap to use the desired template" do
+      @bootstrap.config[:template_file].should == '~/.chef/templates/my-bootstrap.sh.erb'
+    end
+
+    it "configured the bootstrap to set an openstack hint (via Chef::Config)" do
+      Chef::Config[:knife][:hints]['openstack'].should_not be_nil
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knife-openstack
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-11 00:00:00.000000000 Z
+date: 2013-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
@@ -44,6 +44,86 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.10.10
+- !ruby/object:Gem::Dependency
+  name: knife-windows
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: OpenStack Compute Support for Chef's Knife Command
 email:
 - schisamo@opscode.com
@@ -69,6 +149,8 @@ files:
 - lib/chef/knife/openstack_server_delete.rb
 - lib/chef/knife/openstack_server_list.rb
 - lib/knife-openstack/version.rb
+- spec/spec_helper.rb
+- spec/unit/openstack_server_create_spec.rb
 homepage: https://github.com/opscode/knife-openstack
 licenses: []
 post_install_message: 
@@ -93,4 +175,6 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: OpenStack Compute Support for Chef's Knife Command
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/unit/openstack_server_create_spec.rb