knife-rightscale 0.0.3 → 0.1.0

data/CHANGELOG

@@ -1,4 +1,6 @@
 v0.0.2
   * initial release
 v0.0.3
-  * Updated Gemspec with right_api_client dependency. by kevinkarwaski
+  * Updated Gemspec with right_api_client dependency. by kevinkarwaski
+v0.0.4
+  * retrofit to use right_api_provision client gem

data/Gemfile

@@ -1,4 +1,6 @@
 source 'https://rubygems.org'
 
+gem "right_api_provision"
+
 # Specify your gem's dependencies in knife-rightscale.gemspec
 gemspec

data/README.md

@@ -1,60 +1,54 @@
 # Knife RightScale
 
-This is a Knife plugin for RightScale. This plugin gives knife the ability to 
-provision servers on clouds managed by the RightScale platform.  It is expected 
-that you already have a Chef Server running or are using a hosted Chef solution 
+This is a Knife plugin for RightScale. This plugin gives knife the ability to
+provision servers on clouds managed by the RightScale platform.  It is expected
+that you already have a Chef Server running or are using a hosted Chef solution
 from OpsCode.
 
 NOTE: this plugin is currently under development and subject to change
 
 ## REQUIREMENTS:
 
-You will need a RightScale account with at least one cloud registered.  You can 
-sign up for a free trial account [here](https://www.rightscale.com).  
-
-I was lazy and only added support for the RightScale API 1.5 (since API 1.0 is 
-EC2 only and deprecated).  As such, this plugin cannot currently provision 
-servers on EC2. If you need this capability and would like to part in a private 
-beta to enable that functionality, please contact support@rightscale.com and 
-they will hook you up.  If you have any problems, please send me an email 
-directly.
+You will need a RightScale account with at least one cloud registered.  You can
+sign up for a free trial account [here](https://www.rightscale.com).
 
 You will also need a running Chef Server.  If you don't already have one you can
 sign up for a free trial of Hosted Chef from Opscode [here](http://www.opscode.com/hosted-chef/).
 
+If you have an existing account and want to provision on EC2 clouds, you may need to migrate your account to the Unified Cloud Platform. Please see [here](http://support.rightscale.com/Announcements/2013-09-20_Unified_Cloud_Platform_Migration_Details) for more info on UCP.
 
 ## INSTALLATION:
 
 Be sure you are running the latest version Chef 10. Versions earlier than 0.10.0
 don't support plugins.  This has not yet been tested with Chef 11.
 
-    gem install chef -v 10.24.0
+    gem install chef -v 10.26.0
 
 This plugin is distributed as a Ruby Gem. To install it, run:
 
     gem install knife-rightscale
 
-Depending on your system's configuration, you may need to run this command with 
+Depending on your system's configuration, you may need to run this command with
 root privileges.
 
 ## CONFIGURATION:
 
-In order to communicate with the RightScale API you will have to tell Knife 
-about your RightScale account information.  The easiest way to accomplish this 
+In order to communicate with the RightScale API you will have to tell Knife
+about your RightScale account information.  The easiest way to accomplish this
 is to create some entries in your <tt>knife.rb</tt> file:
 
     knife[:rightscale_user]  = "you@yourdomain.com"
     knife[:rightscale_password] = "supersecretpassword"
     knife[:rightscale_account_id] = "1234"
 
-If your knife.rb file will be checked into a SCM system (ie readable by others) 
+If your knife.rb file will be checked into a SCM system (i.e. readable by others)
 you may want to read the values from environment variables:
 
     knife[:rightscale_user] = "#{ENV['RIGHTSCALE_EMAIL']}"
     knife[:rightscale_password] = "#{ENV['RIGHTSCALE_PASSWORD']}"
 
-You also have the option of passing your RightScale credentials into the 
-individual knife subcommands using the <tt>-A</tt> (or <tt>--rightscale-account-id</tt>), 
+You also have the option of passing your RightScale credentials into the
+individual knife subcommands using the <tt>-A</tt> (or <tt>--rightscale-account-id</tt>),
 <tt>-U</tt> (or <tt>--rightscale-user</tt>), <tt>-P</tt> (or <tt>--rightscale-password</tt>) command options
 
 ## Provision a Server
@@ -72,18 +66,18 @@ to filter by partial name match use ```-n``` or ```--name``` option
 List the ServerTemplates available in your account.  Typically you will just want to find a Chef Client template.  For example:
 
     knife rightscale servertemplate list --name "Chef Client"
-    
+
 ### Launch a server
 To provision a new server, supply ServerTemplate choice and target cloud as options:
 
     knife rightscale server create \
       --cloud "Rackspace Open Cloud - Chicago" \
       --server-template "Chef Client (v13.4)" \
-      --deployment "CKP: My Sandbox" \
-      --name "CKP:ChefClient" \
+      --deployment "CP: My Sandbox" \
+      --name "CP:ChefClient" \
       --input "chef/client/server_url":"text:https://api.opscode.com/organizations/kindsol" \
-      --input "chef/client/validation_name":"cred:CKP: validation_client_name" \
-      --input "chef/client/validator_pem":"cred:CKP:validator.pem" \
+      --input "chef/client/validation_name":"cred:CP: validation_client_name" \
+      --input "chef/client/validator_pem":"cred:CP:validator.pem" \
       --input "chef/client/node_name":"text:MyChefClient" \
       --input "chef/client/roles":"text:hello_world"
 
@@ -105,15 +99,15 @@ use the ```--yes``` option to bypass confirmation.
 
 ## OTHER SUBCOMMANDS:
 
-Some other subcommands that can be useful for provisioning servers are listed 
-below.  These are intended to query possible options that you can pass to the 
-server create command. 
+Some other subcommands that can be useful for provisioning servers are listed
+below.  These are intended to query possible options that you can pass to the
+server create command.
 
 All supported command options can be found by invoking:
 
-    knife rightscale --help 
+    knife rightscale --help
 
-Specific details for each command can be found by passing the ```--help``` 
+Specific details for each command can be found by passing the ```--help```
 option the the subcommand.  For example:
 
     knife rightscale <subcommand> --help
@@ -127,7 +121,7 @@ List the supported images for a given ServerTemplate and target cloud
       --cloud "Rackspace Open Cloud - Chicago"
 
 This will also indicate the default Instance Type or flavor for each image.
-
+
 
 ### List Deployments
 To list all the deployments available in your RightScale account:
@@ -142,7 +136,7 @@ To list all the Security Groups available per cloud:
 
     knife rightscale securitygroup list
 
-to filter by partial name match use the ```--name``` option or narrow the 
+to filter by partial name match use the ```--name``` option or narrow the
 results using the ```--cloud``` option
 
 
@@ -153,6 +147,22 @@ To list all the servers in your RightScale account:
 
 to filter by partial name match use the ```--name``` option
 
+## DEVELOPMENT
+
+You can develop this plugin with out installing it using the bundler gem.  First clone this repository, change to the working directory and run:
+
+	bundle
+
+Verify the unit test pass:
+
+	bundle exec rake spec
+
+Once those are passing you can run the plugin using `bundle exec`.  For example, to view the help message run:
+
+	bundle exec knife rightscale --help
+
+Happy hacking!
+
 
 ## FUTURE FEATURES
  * create action
@@ -163,11 +173,11 @@ to filter by partial name match use the ```--name``` option
  ** Private beta
  * display audit entry when server strands
  * ability to add server tags on create
- * server array create action 
- * add timeout for operational 
+ * server array create action
+ * add timeout for operational
  * credentials list action (waiting for new API release)
  * add VPC support to create action
- 
+
 
 ## LICENSE:
 
@@ -176,7 +186,7 @@ Copyright:: Copyright (c) 2013 RightScale, Inc.
 License:: Apache License, Version 2.0
 See attribution notice in README.md
 
-This readme is modified from the knife-ec2 plugin project code 
+This readme is modified from the knife-ec2 plugin project code
 That project is located at https://github.com/opscode/knife-ec2
 Author:: Adam Jacob (<adam@opscode.com>)
 Copyright:: Copyright (c) 2009-2011 Opscode, Inc.

data/Rakefile

@@ -1,5 +1,3 @@
-require "bundler/gem_tasks"
-
 #
 # Author:: Cary Penniman (<cary@rightscale.com>)
 # Copyright:: Copyright (c) 2013 RightScale, Inc.
@@ -17,6 +15,20 @@ require "bundler/gem_tasks"
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+require "bundler/gem_tasks"
+require "rdoc/task"
+require "yard"
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb']
+end
+
+Rake::RDocTask.new(:rdoc) do |rd|
+  rd.main = "README.doc"
+  rd.rdoc_files.include("README.md", "lib/**/*.rb")
+  rd.options << "--all"
+end
+
 require 'rspec/core/rake_task'
 
 desc "Run all specs in spec directory"

data/knife-rightscale.gemspec

@@ -33,7 +33,11 @@ Gem::Specification.new do |gem|
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.add_dependency "right_api_client", "~> 1.5"
+  gem.add_dependency "right_api_helper", ">= 1.1.2"
+  gem.add_dependency "rake"
+  gem.add_dependency "yard"
+  gem.add_dependency "rspec"
+  gem.add_dependency "chef"
 
   gem.require_paths = ["lib"]
 end

data/lib/chef/knife/rightscale_base.rb

@@ -3,7 +3,7 @@
 # Copyright:: Copyright (c) 2013 RightScale, Inc.
 # License:: Apache License, Version 2.0
 #
-# This file is modified from the knife-ec2 plugin project code 
+# This file is modified from the knife-ec2 plugin project code
 # That project is located at https://github.com/opscode/knife-ec2
 # Author:: Seth Chisamore <schisamo@opscode.com>
 # Copyright:: Copyright (c) 2011 Opscode, Inc.
@@ -22,8 +22,7 @@
 # limitations under the License.
 #
 require 'chef/knife'
-require 'right_api_provision/provisioner'
-require 'right_api_provision/api15'
+require 'right_api_helper'
 
 class Chef
   class Knife
@@ -36,7 +35,7 @@ class Chef
         includer.class_eval do
 
           deps do
-            require 'right_api_client'
+            require 'right_api_helper'
           end
 
           option :rightscale_user,
@@ -69,17 +68,31 @@ class Chef
 
       def connection
         @connection ||= begin
-          client = ::RightApiProvision::API15.new
-          client.connection(
-            Chef::Config[:knife][:rightscale_user], 
-            Chef::Config[:knife][:rightscale_password],  
-            Chef::Config[:knife][:rightscale_account_id], 
-            Chef::Config[:knife][:rightscale_api_url]
-          )
-          client
+          api_shim = RightApiHelper::API15.new(right_api_client)
+          set_log_level(api_shim)
+          api_shim
         end
       end
 
+      def right_api_client
+        @right_api_client ||= begin
+          session = RightApiHelper::Session.new
+          set_log_level(session)
+          right_api_client = session.create_client(
+              Chef::Config[:knife][:rightscale_user],
+              Chef::Config[:knife][:rightscale_password],
+              Chef::Config[:knife][:rightscale_account_id],
+              Chef::Config[:knife][:rightscale_api_url]
+            )
+          right_api_client
+        end
+      end
+
+      def set_log_level(obj)
+        log_level = (config[:verbosity] >= 1) ? Logger::DEBUG : Logger::INFO
+        obj.log_level(log_level)
+      end
+
       def locate_config_value(key)
         key = key.to_sym
         config[key] || Chef::Config[:knife][key]
@@ -96,7 +109,7 @@ class Chef
 
         keys.each do |k|
           pretty_key = k.to_s.gsub(/_/, ' ').gsub(/\w+/){ |w| (w =~ /(ssh)|(aws)/i) ? w.upcase  : w.capitalize }
-          if Chef::Config[:knife][k].nil?
+          if Chef::Config[:knife][k].nil? && config[k].nil?
             errors << "You did not provide a valid '#{pretty_key}' value."
           end
         end

data/lib/chef/knife/rightscale_cloud_list.rb

@@ -25,7 +25,7 @@ class Chef
       include Knife::RightscaleBase
 
       deps do
-        require 'right_api_client'
+        require 'right_api_helper'
         require 'timeout'
       end
 

data/lib/chef/knife/rightscale_deployment_list.rb

@@ -25,7 +25,7 @@ class Chef
       include Knife::RightscaleBase
 
       deps do
-        require 'right_api_client'
+        require 'right_api_helper'
       end
       
       option :deployment_name,

data/lib/chef/knife/rightscale_image_list.rb

@@ -25,7 +25,7 @@ class Chef
       include Knife::RightscaleBase
 
       deps do
-        require 'right_api_client'
+        require 'right_api_helper'
       end
 
       option :server_template,

data/lib/chef/knife/rightscale_securitygroup_list.rb

@@ -25,15 +25,15 @@ class Chef
       include Knife::RightscaleBase
 
       deps do
-        require 'right_api_client'
+        require 'right_api_helper'
       end
-      
+
       option :security_group_name,
         :short => "-n SECURITYGROUP_NAME",
         :long => "--name SECURITYGROUP_NAME",
         :description => "The partial name of the security group to search for",
         :proc => Proc.new { |i| Chef::Config[:knife][:security_group_name] = i }
-        
+
       option :cloud_name,
         :short => "-C CLOUD_NAME",
         :long => "--cloud CLOUD_NAME",
@@ -54,9 +54,10 @@ class Chef
           ui.color('Name', :bold),
           ui.color('Resource UID', :bold)
         ].flatten.compact
-      
+
         output_column_count = security_group_list.length
         @clouds.each do |cloud|
+          next unless connection.requires_security_groups?(cloud)
           @security_groups = connection.list_security_groups(cloud, :by_name, config[:security_group_name])
           @security_groups.each do |security_group|
             security_group_list << cloud.name
@@ -66,13 +67,13 @@ class Chef
         end
         puts ui.list(security_group_list, :uneven_columns_across, output_column_count)
       end
-      
+
       private
 
       def validate!
         super([:rightscale_user, :rightscale_password, :rightscale_account_id])
       end
-      
+
     end
   end
 end

data/lib/chef/knife/rightscale_server_create.rb

@@ -3,7 +3,7 @@
 # Copyright:: Copyright (c) 2013 RightScale, Inc.
 # License:: Apache License, Version 2.0
 #
-# This file is modified from the knife-ec2 plugin project code 
+# This file is modified from the knife-ec2 plugin project code
 # That project is located at https://github.com/opscode/knife-ec2
 # Author:: Adam Jacob (<adam@opscode.com>)
 # Author:: Seth Chisamore (<schisamo@opscode.com>)
@@ -32,7 +32,7 @@ class Chef
       include Knife::RightscaleBase
 
       deps do
-        require 'right_api_client'
+        require 'right_api_helper'
       end
 
       banner "knife rightscale server create (options)"
@@ -50,8 +50,7 @@ class Chef
         :short => "-s NAME",
         :long => "--server-template NAME",
         :description => "The name of the ServerTemplate or ID to use for the server",
-        :proc => Proc.new { |i| Chef::Config[:knife][:server_template] = i },
-        :required => true
+        :proc => Proc.new { |i| Chef::Config[:knife][:server_template] = i }
 
       option :server_name,
         :short => "-n SERVERNAME",
@@ -78,20 +77,20 @@ class Chef
         :long => "--input NAME:VALUE",
         :description => "An input name and value",
         :proc => lambda { |o| k,v=o.split(":",2); @@inputs[k]=v }
-      
+
       option :ssh_key_name,
         :short => "-S KEY_UUID",
         :long => "--ssh-key KEY_UUID",
         :description => "The AWS SSH key resource UUIS",
         :proc => Proc.new { |key| Chef::Config[:knife][:ssh_key_uuid] = key }
-        
+
       # Gets applied to chef/client/roles input of ServerTemplate, if it exists
       # 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(/[\s,]+/) }
-      # 
+      #
       # option :json_attributes,
       #   :short => "-j JSON",
       #   :long => "--json-attributes JSON",
@@ -102,7 +101,7 @@ class Chef
       #   :long => "--bootstrap-version VERSION",
       #   :description => "The version of Chef to install",
       #   :proc => Proc.new { |v| Chef::Config[:knife][:bootstrap_version] = v }
-      # 
+      #
       # option :chef_node_name,
       #   :short => "-N NAME",
       #   :long => "--node-name NAME",
@@ -114,19 +113,25 @@ class Chef
       #   :long => "--flavor FLAVOR",
       #   :description => "The flavor of server (m1.small, m1.medium, etc)",
       #   :proc => Proc.new { |f| Chef::Config[:knife][:flavor] = f }
-      # 
+      #
       # option :image,
       #   :short => "-I IMAGE",
       #   :long => "--image IMAGE",
       #   :description => "The AMI for the server",
       #   :proc => Proc.new { |i| Chef::Config[:knife][:image] = i }
-      # 
+      #
       option :security_groups,
               :short => "-G X,Y,Z",
               :long => "--groups X,Y,Z",
               :description => "The security groups for this server; not allowed when using VPC",
               :proc => Proc.new { |groups| groups.split(',') }
 
+      option :wait_for_operational,
+              :long => "--[no-]block",
+              :description => "Exit after server launch -- don't wait for operational. (non-blocking)",
+              :boolean => true,
+              :default => true
+
       def run
         $stdout.sync = true
 
@@ -139,27 +144,34 @@ class Chef
         print "\n#{ui.color("Cloud:", :magenta)} #{config[:cloud_name]}"
         print "\n#{ui.color("Deployment name:", :magenta)} #{config[:deployment_name]}"
         print "\n#{ui.color("Inputs:", :magenta)} #{@@inputs}"
+        print "\n#{ui.color("Wait for Operational:", :magenta)} FALSE" if config[:no_wait]
         print "\n"
-        
-        rightscale = ::RightApiProvision::Provisioner.new(connection)
+
+        rightscale = get_rightscale_provisioner
         rightscale.provision(
-          config[:server_template], 
-          config[:server_name], 
-          config[:cloud_name], 
-          config[:deployment_name],
-          @@inputs,
-          config[:ssh_key_name],
-          config[:security_groups]
-        )
-        
+                  config[:server_name],
+                  config[:server_template],
+                  config[:cloud_name],
+                  config[:deployment_name],
+                  @@inputs,
+                  nil, # MCI not yet supported
+                  config[:ssh_key_name],
+                  config[:security_groups]
+                )
+
+        unless config[:wait_for_operational]
+          print "#{ui.color("Server launched -- exiting.", :green)}"
+          return
+        end
+
         if rightscale.server_ready?
           print "#{ui.color("Server already running", :green)}"
-        else
+        elsif
           print "\n#{ui.color("Waiting for RightScale to configure server\n", :yellow)}"
           rightscale.wait_for_operational
           print "\n"
         end
-        
+
         # output connection information
         print "#{ui.color("Querying server info...\n", :magenta)}"
         info = rightscale.server_info
@@ -172,6 +184,10 @@ class Chef
 
     private
 
+      def get_rightscale_provisioner
+        RightApiHelper::Provisioner.new(right_api_client)
+      end
+
       def validate!
         super([:cloud_name, :deployment_name, :server_template, :rightscale_user, :rightscale_password, :rightscale_account_id])
       end