knife-vcloud 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd99b0e22773c4e32b18849f23e04232c29f1119
-  data.tar.gz: 7402cb3ab4a9d15f835936fc253c9bd4bf80c3eb
+  metadata.gz: 5e1a6581ab79e682545433b7cd7bfa2517c1be97
+  data.tar.gz: dddf81518b3eeb63a7d65e4493d522c57c34a998
 SHA512:
-  metadata.gz: cfa1352af5c09e4555d92aee07d88ea50d7ac3ce1503aea51a17982488d4d4f24ea10612c9a6d62ba658951a12b2eb759f101bcc1d77b9c2a9ca7c7362ed4dbe
-  data.tar.gz: 0b2caca9edfcfbd9832654868a16ff00d3c16d6bae8351dbde26aa8f81b927c1276c5d81758becab3c6f112718cf20691d55429f6c6ef82726d3215d8eb64f81
+  metadata.gz: 232a90edc098da6619adbba3d7f67d6db238ad46bce3243f7c3b2aa7eeed0f7e8cc81d846ea0978d32fdf5161414d10c8d096a16c7d2b8ba63dfcabfef258311
+  data.tar.gz: bdff29d51a5dee502ab2c1ebc6db8e15a0f34c464a1b5a903cf93ba0d61d922864591e4bc18a4c578593db61349daf861c095dc78959dba3c8e41226c14c67d1

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 Changes
 ==
+2013-12-13 (1.1.0)
+--
+
+This version introduces new features and deprecations.  
+Deprecated features will be dropped in the future release.
+
+FEATURES:
+
+* Add option *--override-guest* to `vm set info` to rename also its guest name (*false* by default for backward-compatibility)
+* Add command `vm network [add|delete|edit]` to manage multiple networks
+* Use RSA keys to manage passwords
+* Add command `knife vc configure` to manage knife-vcloud's configuration
+
+DEPRECATIONS:
+
+* `vm config network` is now deprecated
+* *knife[:vcloud_password_login]* is now deprecated and should be replaced using ```knife vc configure```
+
 2013-11-29 (1.0.0)
 --
 

data/README.md

@@ -42,6 +42,7 @@ USAGE
 
     knife vc catalog item show [CATALOG_ITEM] (options)
     knife vc catalog show [CATALOG] (options)
+    knife vc configure (options)
     knife vc login (options)
     knife vc network show [network] (options)
     knife vc org list (options)
@@ -63,7 +64,8 @@ USAGE
     knife vc vdc show VDC (options)
     knife vc vm bootstrap [VM] (options)
     knife vc vm config guest [VM] (options)
-    knife vc vm config network [VM] [NETWORK_NAME] (options)
+    [DEPRECATED] knife vc vm config network [VM] [NETWORK_NAME] (options)
+    knife vc vm network [add|delete|edit| [VM] [NETWORK] (options)
     knife vc vm reboot [VM] (options)
     knife vc vm reset [VM] (options)
     knife vc vm set disks [VM] (options)
@@ -75,7 +77,20 @@ USAGE
 
 ###Configuration
 
-Configuration options can be set either via arguments or inside the *.chef/knife.rb* file.
+A first configuration should be done using ```knife vc configure``` that would prompt user for
+credentials and vCloud URL.
+
+**DEPRECATION NOTE: *vcloud_password_login* has been deprecated and will be removed in future versions.**
+
+E.g.,
+
+    $ bundle exec knife vc configure
+    Loading existing pem
+    vCloud URL (https://mycloud.test.com):
+    vCloud username (testuser):
+    ...
+
+Other configuration options can be set either via arguments or inside the *.chef/knife.rb* file.
 The only difference is that in *knife.rb* dashes must be converted to underscores
 and *vcloud_* must be prepended.
 
@@ -95,7 +110,6 @@ to use:
 The following options specify user's credentials and thus are accepted by every command:
 
     --user-login USER
-    --password-login SECRET
     --org-login ORGANIZATION
 
 **Knife.rb configuration example:**
@@ -103,7 +117,7 @@ The following options specify user's credentials and thus are accepted by every
     knife[:vcloud_url] = 'https://vcloud.server.org'
     knife[:vcloud_org_login] = 'vcloud_organization'
     knife[:vcloud_user_login] = 'vcloud_user'
-    knife[:vcloud_password_login] = 'vcloud_password'
+    knife[:vcloud_password] = <MUST BE GENERATED WITH knife vc configure>
     (OPTIONAL) knife[:vcloud_api_version] = '1.5'
 
 ####IDs and names
@@ -386,6 +400,9 @@ _Example:_
 ###Set VM's CPUs / Memory / Name
 This command sets name, CPUs and RAM info for a given VM.
 
+Renaming a VM implies renaming its guest name.
+Use ```--no-override-guest-name``` if you want to preserve the old name.
+
 _Example:_
 
     $ knife vc vm set info --name NewName --vapp vApp_test vm-test
@@ -422,16 +439,50 @@ _Example:_
     Summary: Status: success - time elapsed: 7.21 seconds
 
 ###VM's network configuration
-This command allows for basic VM network configuration.
-E.g., set IP allocation mode (defaults to POOL)
+VM networks can be added, removed and modified using the *vm network* command.
+This commands allows for basic VM network configuration and accepts several options to configure a given network (see *knife vc vm network --help* for details).
 
 Please note that you must use the human readable name of the network (i.e., _TestNet\_1_).
 
-_Example:_
+**DEPRECATION NOTE: The command *vm config network* has been deprecated and will be removed in future versions.**
+
+_Add example:_
+
+    $ knife vc vm network edit testvm TST_Data
+    Forcing parent network to itself
+    VM network configuration...
+    Guest customizations must be applied to a stopped VM, but it's running. Can I STOP it? (Y/N) y
+    Stopping VM...
+    Summary: Status: success - time elapsed: 1.617 seconds
+    Adding TST_Data to VM...
+    Summary: Status: success - time elapsed: 5.866 seconds
+    Forcing Guest Customization to apply changes...
+    Summary: Status: success - time elapsed: 13.387 seconds
+
+_Edit example:_
+
+    $ knife vc vm network edit testvm TST_Data --ip-allocation-mode DHCP
+    Forcing parent network to itself
+    VM network configuration...
+    Guest customizations must be applied to a stopped VM, but it's running. Can I STOP it? (Y/N) y
+    Stopping VM...
+    Summary: Status: success - time elapsed: 5.34 seconds
+    VM network configuration for TST_Data...
+    Summary: Status: success - time elapsed: 3.397 seconds
+    Forcing Guest Customization to apply changes...
+    Summary: Status: success - time elapsed: 8.01 seconds
+
+_Delete example:_
 
-    $ knife vc vm config network test_vm TestNet_1 --vapp test_vapp1
+    $ knife vc vm network delete test_vm TST_Data
     VM network configuration...
-    Summary: Status: success - time elapsed: 4.35 seconds
+    Guest customizations must be applied to a stopped VM, but it's running. Can I STOP it? (Y/N) y
+    Stopping VM...
+    Summary: Status: success - time elapsed: 4.77 seconds
+    Removing TST_Data from VM...
+    Summary: Status: success - time elapsed: 3.614 seconds
+    Forcing Guest Customization to apply changes...
+    Summary: Status: success - time elapsed: 11.194 seconds
 
 ###VM's Guest Customization configuration
 This command allows for basic VM Guest Customization configuration.

data/lib/chef/knife/common/vc_common.rb

@@ -18,9 +18,13 @@
 
 require 'chef/knife'
 require 'date'
+require 'openssl'
+require 'base64'
 
 class Chef
   class Knife
+    class ConfigurationError < StandardError; end
+
     module VcCommon
       def self.included(includer)
         includer.class_eval do
@@ -75,10 +79,28 @@ class Chef
 
       def connection
         unless @connection
+          pemfile = locate_config_value(:vcloud_pem)
+
+          if locate_config_value(:vcloud_password_login)
+            ui.info("#{ui.color('DEPRECATION WARNING:', :bold)} knife[:vcloud_password_login] is deprecated" \
+                  " and will be removed in the next version. You should remove it and run 'knife vc configure'.")
+            passwd = locate_config_value(:vcloud_password_login)
+          else
+            unless pemfile
+              raise ConfigurationError, "PEM file not configured. Please run 'knife vc configure'"
+            end
+
+            unless locate_config_value(:vcloud_password)
+              raise ConfigurationError, "Password not configured. Please run 'knife vc configure'"
+            end
+
+            passwd = get_password(pemfile)
+          end
+
           @connection = VCloudClient::Connection.new(
               locate_config_value(:vcloud_url),
               locate_config_value(:vcloud_user_login),
-              locate_config_value(:vcloud_password_login),
+              passwd,
               locate_config_value(:vcloud_org_login),
               locate_config_value(:vcloud_api_version)
           )
@@ -119,6 +141,13 @@ class Chef
         end
       end
 
+      def deprecation_msg(value)
+        if value && !value.empty?
+          ui.info("#{ui.color('DEPRECATION WARNING:', :bold)} This method is deprecated" \
+                  " and will be removed in the next version. You should use #{value}.")
+        end
+      end
+
       def locate_config_value(key)
         key = key.to_sym
         Chef::Config[:knife][key] || config[key]
@@ -147,6 +176,63 @@ class Chef
         collection.sort_by {|k, v| k }
       end
 
+      # Generate a new key pair and store it on knife.rb
+      def generate_key(dir="#{File.join(Dir.home, '.chef')}", output="vc_key.pem")
+        key = OpenSSL::PKey::RSA.new 2048
+
+        pemfile = File.join(dir, output)
+
+        File.open("#{pemfile}", 'w') do |io| io.write key.to_pem end
+        FileUtils.chmod 0600, pemfile
+
+        store_config(:vcloud_pem, pemfile)
+      end
+
+      # Store a password in knife.rb
+      def store_password(keyfile)
+        pub_key = OpenSSL::PKey::RSA.new(File.read(keyfile)).public_key
+        result = Base64.encode64(pub_key.public_encrypt(ui.ask("Enter your password: ") { |q| q.echo = false }))
+        store_config(:vcloud_password, result.gsub("\n", ''))
+      end
+
+      # Retrieve a stored password
+      def get_password(keyfile)
+        priv_key = OpenSSL::PKey::RSA.new(File.read(keyfile))
+        result = priv_key.private_decrypt(Base64.decode64(locate_config_value(:vcloud_password)))
+        result
+      end
+
+      # Update knife.rb with an entry knife[:KEY] = VALUE
+      #
+      # It checks whether a given configuration already exists and, if so, updates it
+      def store_config(key, value)
+        configfile = File.join(Dir.home, '.chef', 'knife.rb')
+        old_config = File.open(configfile, 'r').readlines
+        full_key = "knife[:#{key}]"
+
+        if Chef::Config[:knife][key]
+          # Replace existing key
+          File.open("#{configfile}.tmp", 'w') do |new_config|
+            old_config.each do |line|
+              if line =~ Regexp.new("^#{Regexp.escape(full_key)}")
+                line = "#{full_key} = '#{value}'"
+              end
+              new_config.puts line
+            end
+          end
+
+          FileUtils.mv("#{configfile}.tmp", configfile)
+        else
+          # Create a new one
+          File.open(configfile, 'a') do |new_config|
+            new_config.puts "#{full_key} = '#{value}'"
+          end
+        end
+
+        # Reload Chef configuration
+        self.configure_chef
+      end
+
       private
         def humanize_elapsed_time(start_time, end_time)
           start_time = Time.parse(start_time || Time.now)

data/lib/chef/knife/vc_commands.rb

@@ -56,6 +56,7 @@ require 'chef/knife/vapp/vc_vapp_snapshot'
 require 'chef/knife/common/vc_vm_common'
 require 'chef/knife/vm/vc_vm_config_guest'
 require 'chef/knife/vm/vc_vm_config_network'
+require 'chef/knife/vm/vc_vm_network'
 require 'chef/knife/vm/vc_vm_show'
 require 'chef/knife/vm/vc_vm_set_info'
 require 'chef/knife/vm/vc_vm_set_disks'

data/lib/chef/knife/vc_configure.rb

@@ -0,0 +1,71 @@
+#
+# Author:: Stefano Tortarolo (<stefano.tortarolo@gmail.com>)
+# Copyright:: Copyright (c) 2013
+# 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 'chef/knife/common/vc_common'
+
+class Chef
+  class Knife
+    class VcConfigure < Chef::Knife
+      include Knife::VcCommon
+
+      banner "knife vc configure (options)"
+
+      option :change_password,
+             :short => "-p",
+             :long => "--[no-]change-password",
+             :description => "Change the stored password",
+             :boolean => true,
+             :default => false
+
+      def run
+        $stdout.sync = true
+
+        # Load or generate a keypair to encrypt info
+        pemfile = locate_config_value(:vcloud_pem)
+        if pemfile
+          ui.msg("Loading existing pem")
+          keyfile = "#{pemfile}"
+        else
+          ui.msg("PEM file not existing. Creating one.")
+          generate_key()
+          keyfile = locate_config_value(:vcloud_pem)
+        end
+
+        value = ui.ask("vCloud URL (%s): " % locate_config_value(:vcloud_url))
+        unless value.empty?
+          store_config(:vcloud_url, value)
+        end
+
+        value = ui.ask("vCloud username (%s): " % locate_config_value(:vcloud_user_login))
+        unless value.empty?
+          store_config(:vcloud_user_login, value)
+        end
+
+        value = ui.ask("vCloud API version (%s): " % (locate_config_value(:vcloud_api_version) || "5.1"))
+        unless value.empty?
+          store_config(:vcloud_api_version, value)
+        end
+
+        if !locate_config_value(:vcloud_password) ||
+                locate_config_value(:change_password)
+          store_password(keyfile)
+        end
+      end
+    end
+  end
+end

data/lib/chef/knife/vm/vc_vm_config_guest.rb

@@ -91,7 +91,7 @@ class Chef
 
         guest_name = sanitize_guest_name(computer_name)
 
-        ui.msg "Renaming guest name to #{guest_name}..."
+        ui.msg "Renaming guest name to #{guest_name}..." if locate_config_value(:guest_computer_name)
         task_id, response = connection.set_vm_guest_customization vm[:id], guest_name, config
 
         ui.msg "VM guest configuration..."

data/lib/chef/knife/vm/vc_vm_config_network.rb

@@ -62,6 +62,8 @@ class Chef
 
         connection.login
 
+        deprecation_msg("vm network [add|delete|edit]")
+
         vm = get_vm(vm_arg)
 
         stop_if_running(connection, vm)

data/lib/chef/knife/vm/vc_vm_network.rb

@@ -0,0 +1,132 @@
+#
+# Author:: Stefano Tortarolo (<stefano.tortarolo@gmail.com>)
+# Copyright:: Copyright (c) 2012-2013
+# 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.
+#
+
+class Chef
+  class Knife
+    class VcVmNetwork < Chef::Knife
+      include Knife::VcCommon
+      include Knife::VcVmCommon
+      include Knife::VcNetworkCommon
+
+      banner "knife vc vm network [add|delete|edit| [VM] [NETWORK] (options)"
+
+      option :vm_net_index,
+             :long => "--net-index NETWORK_IDX",
+             :description => "Index of the current network interface"
+
+      option :vm_net_ip,
+             :long => "--net-ip NETWORK_IP",
+             :description => "IP of the current network interface"
+
+      option :vm_net_is_connected,
+             :long => "--net-[no-]connected",
+             :description => "Toggle IsConnected flag of the current network interface (default true)",
+             :boolean => true,
+             :default => true
+
+      option :vm_ip_allocation_mode,
+             :long => "--ip-allocation-mode ALLOCATION_MODE",
+             :description => "Set IP allocation mode of the current network interface (default POOL)",
+             :default => 'POOL'
+
+      def run
+        $stdout.sync = true
+
+        command_arg = @name_args.shift
+        vm_arg = @name_args.shift
+        network_arg = @name_args.shift
+
+        unless command_arg =~ /add|delete|edit/
+          raise ArgumentError, "Invalid command #{command_arg} supplied. Only add, delete and edit are allowed."
+        end
+
+        command = command_arg.to_sym
+
+        config = {
+          :network_index => locate_config_value(:vm_net_index),
+          :ip => locate_config_value(:vm_net_ip),
+          :is_connected => locate_config_value(:vm_net_is_connected),
+          :ip_allocation_mode => locate_config_value(:vm_ip_allocation_mode),
+          :retain_network => locate_config_value(:retain_network)
+        }
+
+        connection.login
+
+        vm = get_vm(vm_arg)
+        network = get_network network_arg
+
+        unless network
+          raise new ArgumentError, "Network #{network_arg} not found in vDC."
+        end
+
+        unless command == :delete
+          parent_network_arg = locate_config_value(:parent_network)
+          if parent_network_arg
+            ui.msg "Retrieving parent network details"
+            parent_network = get_network parent_network_arg
+            config[:parent_network] =  { :id => parent_network[:id],
+                                         :name => parent_network[:name] }
+          else
+            ui.msg "Forcing parent network to itself"
+            config[:parent_network] = { :id => network[:id],
+                                        :name => network[:name] }
+          end
+        end
+
+        ui.msg "VM network configuration..."
+        stop_if_running(connection, vm)
+
+        case command
+          when :add
+            ui.msg "Adding #{network[:name]} to VM..."
+            task_id, response = connection.add_vm_network vm[:id], network, config
+            result = wait_task(connection, task_id)
+          when :delete
+            ui.msg "Removing #{network[:name]} from VM..."
+            task_id, response = connection.delete_vm_network vm[:id], network
+            result = wait_task(connection, task_id)
+          when :edit
+            ui.msg "VM network configuration for #{network[:name]}..."
+            task_id, response = connection.edit_vm_network vm[:id], network, config
+            result = wait_task(connection, task_id)
+        end
+
+        if result
+          unless vm[:guest_customizations][:enabled]
+            config = {
+              :enabled => true,
+              :admin_passwd_enabled => vm[:guest_customizations][:admin_passwd_enabled],
+              :admin_passwd => vm[:guest_customizations][:admin_passwd],
+              :customization_script => script
+            }
+
+            ui.msg "Enabling Guest Customization to apply changes..."
+            task_id, response = connection.set_vm_guest_customization vm[:id], guest_name, config
+            wait_task(connection, task_id)
+          end
+
+          ui.msg "Forcing Guest Customization to apply changes..."
+          task_id = connection.force_customization_vm vm[:id]
+          wait_task(connection, task_id)
+        end
+
+        connection.logout
+      end
+    end
+  end
+end

data/lib/chef/knife/vm/vc_vm_set_info.rb

@@ -36,6 +36,12 @@ class Chef
              :long => "--name VM_NAME",
              :description => "Rename the VM"
 
+      option :override_guest_name,
+             :long => "--[no-]override-guest",
+             :description => "Override also Guest Name (used with --name)",
+             :boolean => true,
+             :default => false
+
       def run
         $stdout.sync = true
 
@@ -72,7 +78,28 @@ class Chef
         task_id = connection.rename_vm vm[:id], vm_name
         result = wait_task(connection, task_id)
 
-        return result
+        return unless result && locate_config_value(:override_guest_name)
+
+        # Change also its guest computer name
+        guest_config = {:enabled => true}
+
+        # Inheriting admin_passwd if enabled
+        if vm[:guest_customizations][:admin_passwd_enabled]
+          guest_config[:admin_passwd] = vm[:guest_customizations][:admin_passwd]
+        end
+
+        stop_if_running(connection, vm)
+
+        guest_name = sanitize_guest_name(vm_name)
+
+        ui.msg "Renaming guest name to #{guest_name}..."
+        task_id, response = connection.set_vm_guest_customization vm[:id], guest_name, guest_config
+
+        wait_task(connection, task_id)
+
+        ui.msg "Forcing Guest Customization..."
+        task_id = connection.force_customization_vm vm[:id]
+        wait_task(connection, task_id)
       end
     end
   end

data/lib/chef/knife/vm/vc_vm_show.rb

@@ -63,7 +63,7 @@ class Chef
         vm[:networks].each do |network, values|
           list << [(network || ''), '']
           values.each do |k, v|
-            list << (pretty_symbol(k) || '')
+            list << "  #{(pretty_symbol(k) || '')}"
             list << (v || '')
           end
         end

data/lib/knife-vcloud/version.rb

@@ -1,3 +1,3 @@
 module KnifeVCloud
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knife-vcloud
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Stefano Tortarolo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-29 00:00:00.000000000 Z
+date: 2013-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: winrm
   requirement: !ruby/object:Gem::Requirement
@@ -103,11 +103,13 @@ files:
 - lib/chef/knife/vapp/vc_vapp_stop.rb
 - lib/chef/knife/vapp/vc_vapp_suspend.rb
 - lib/chef/knife/vc_commands.rb
+- lib/chef/knife/vc_configure.rb
 - lib/chef/knife/vc_login.rb
 - lib/chef/knife/vdc/vc_vdc_show.rb
 - lib/chef/knife/vm/vc_vm_bootstrap.rb
 - lib/chef/knife/vm/vc_vm_config_guest.rb
 - lib/chef/knife/vm/vc_vm_config_network.rb
+- lib/chef/knife/vm/vc_vm_network.rb
 - lib/chef/knife/vm/vc_vm_reboot.rb
 - lib/chef/knife/vm/vc_vm_reset.rb
 - lib/chef/knife/vm/vc_vm_set_disks.rb
@@ -142,3 +144,4 @@ signing_key:
 specification_version: 4
 summary: A knife plugin for the VMWare vCloud API
 test_files: []
+has_rdoc: