knife-joyent 0.2.2 → 0.3.0

data/CHANGES.md

@@ -0,0 +1,8 @@
+knife-joyent Changelog
+===
+
+## 0.3.0
+
+- GH-49 Network api support
+- GH-37 Request signing using ssh-agent
+- GH-30 Server list performance fix

data/Gemfile

@@ -1,3 +1,5 @@
 source "http://rubygems.org"
 
+# gem "fog", :github => "fog/fog", :branch => "master"
+
 gemspec

data/README.md

@@ -1,7 +1,7 @@
 Knife Joyent
 ===
 
-This is a [Knife](http://wiki.opscode.com/display/chef/Knife) plugin for Joyent CloudAPI. This plugin gives knife
+This is a [Knife](http://wiki.opscode.com/display/chef/Knife) plug-in for Joyent CloudAPI. This plug-in gives knife
 the ability to create, bootstrap, and manage servers on the [Joyent Public Cloud](http://www.joyentcloud.com/) as well as Cloud providers powered by Joyent's [SmartDataCenter](http://www.joyent.com/products/smartdatacenter/) product offering.
 
 For more information on Joyent CloudAPI, see: [CloudAPI Documentation](http://api.joyentcloud.com/docs)
@@ -25,6 +25,7 @@ Currently available commands:
     knife joyent key add -f <keyfile> -k <name>
     knife joyent key delete <name>
     knife joyent key list
+    knife joyent network list
     knife joyent server create (options)
     knife joyent server delete <server_id>
     knife joyent server list <options>
@@ -63,20 +64,30 @@ The following options can be specified in your knife configuration file
 
 You can authenticate against CloudAPI using either:
 
-a username and password
+an ssh key (recommended)
 
     knife[:joyent_username] = "Your Joyent CloudAPI username"
-    knife[:joyent_password] = "Your Joyent CloudAPI password"
+    knife[:joyent_keyname] = "Name of key stored on Joyent"
+    knife[:joyent_keyfile] = "/path/to/your/private/key"
 
-or, your ssh key
+    # Optional / not-recommended -- defaults to using ssh-agent
+    knife[:joyent_keyphrase] = "mypassphrase"
+
+or username and password
 
     knife[:joyent_username] = "Your Joyent CloudAPI username"
-    knife[:joyent_keyname] = "Name of key stored on Joyent"
-    knife[:joyent_keyfile] = "/path/to/your/private/key"
+    knife[:joyent_password] = "Your Joyent CloudAPI password"
+
+When authenticating with your ssh key (which we highly recommend), knife-joyent will
+attempt to use ssh-agent to sign the request using the key configured with
+``knife[:joyent_keyname]``. If no ssh-agent is present or if the specified identity
+isn't found in the agent, you may be prompted for a pass-phrase. If you do not want
+to use an ``ssh-agent``, you may optionally configure ``knife[:joyent_passphrase]``
+to automatically unlock the key for authentication.
 
-#### Optional
+#### Optional Configuration
 
-**joyent_api_url**
+**``joyent_api_url``**
 
 Specify a custom API endpoint, this is required if you want to specify
 where you want to provision your machines, or if you are using knife with a
@@ -85,7 +96,7 @@ provider powered by [SmartDataCenter](http://www.joyent.com/products/smartdatace
     # Defaults to https://us-west-1.api.joyentcloud.com/
     knife[:joyent_api_url] = "https://us-sw-1.api.joyentcloud.com/"
 
-**joyent_metadata**
+**``joyent_metadata``**
 
 Metadata to apply to each provisioned machine via the Metadata API. This should take
 the form of a hash with a single level of nesting. See the
@@ -95,7 +106,16 @@ the form of a hash with a single level of nesting. See the
       "some_data" => "value"
     }
 
-**provisioner**
+**``joyent_version``**
+
+By default, knife-joyent will use the version of the Joyent Cloud API that fog prefers. This
+can be overridden in knife.rb as follows:
+
+    knife[:joyent_version] = "~7.0"
+
+Some command line options to knife-joyent subcommands may depend on the Joyent API version set.
+
+**``provisioner``**
 
 Machines provisioned will be tagged with key ``provisioner`` containing the value specified.
 This is useful for tracking source of provisions for accounts where machines are provisioned
@@ -104,7 +124,7 @@ by/from different sources / users.
 ## Contributors
 
  - [Sean Omera](https://github.com/someara) - Opscode
- - [Eric Saxby](https://github.com/sax) - ModCloth
+ - [Eric Saxby](https://github.com/sax) - Wanelo
  - [Stephen Lauck](https://github.com/stephenlauck) - ModCloth
 
 ## Bootstrap template for smartos

data/knife-joyent.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.add_dependency "fog", "~> 1.11"
+  s.add_dependency "fog", "~> 1.12.1"
   s.add_dependency "multi_json", "~> 1.7"
   s.add_dependency "chef", ">= 0.10.10"
   s.require_paths = ["lib"]

data/lib/chef/knife/joyent_base.rb

@@ -35,11 +35,21 @@ class Chef
             :description => 'path to ssh private key for signature auth',
             :proc => Proc.new {|key| Chef::Config[:knife][:joyent_keyfile] = key }
 
+          option :joyent_keyphrase,
+            :long => '--joyent-keyphrase <passpharse>',
+            :description => 'ssh passphrase to use if no ssh-agent is present',
+            :proc => Proc.new {|key| Chef::Config[:knife][:joyent_keyphrase] = key }
+
           option :joyent_api_url,
             :short => "-L JOYENT_API_URL",
             :long => "--joyent-api-url JOYENT_API_URL",
             :description => "Joyent API URL",
             :proc => Proc.new {|key| Chef::Config[:knife][:joyent_api_url] = key }
+
+          option :joyent_version,
+            :long => "--joyent-api-version JOYENT_API_VERSION",
+            :description => "Joyent API version",
+            :proc => Proc.new {|key| Chef::Config[:knife][:joyent_version] = key }
         end
       end
 
@@ -51,7 +61,10 @@ class Chef
             :joyent_password => Chef::Config[:knife][:joyent_password],
             :joyent_keyname => Chef::Config[:knife][:joyent_keyname],
             :joyent_keyfile => Chef::Config[:knife][:joyent_keyfile],
-            :joyent_url => Chef::Config[:knife][:joyent_api_url]
+
+            :joyent_url => Chef::Config[:knife][:joyent_api_url],
+            :joyent_version => Chef::Config[:knife][:joyent_version]
+
           )
         end
       end

data/lib/chef/knife/joyent_network_list.rb

@@ -0,0 +1,28 @@
+require 'chef/knife/joyent_base'
+
+class Chef
+  class Knife
+    class JoyentNetworkList < Knife
+      include Knife::JoyentBase
+
+      banner "knife joyent network list"
+
+      def run
+        networks = [
+          ui.color('ID', :bold),
+          ui.color('Name', :bold),
+          ui.color(''),
+        ]
+
+        self.connection.networks.each do |network|
+          networks << network.id
+          networks << network.name
+          networks << (network.public ? 'public' : 'private')
+        end
+
+        puts ui.list(networks, :uneven_columns_across, 3)
+        exit 0
+      end
+    end
+  end
+end

data/lib/chef/knife/joyent_server_create.rb

@@ -51,6 +51,13 @@ class Chef
         :proc => lambda { |o| JSON.parse(o) },
         :default => {}
 
+      option :networks,
+        :short => "-w NETWORKS",
+        :long => "--networks NETWORKS",
+        :description => "Comma separated list of networks to attach (currently requires API version >= 7.0 in knife.rb)",
+        :proc => lambda { |n| n.split(/[\s,]+/)},
+        :default => nil
+
       option :private_network,
         :long => "--private-network",
         :description => "Use the private IP for bootstrapping rather than the public IP",
@@ -129,15 +136,11 @@ class Chef
 
         validate_server_name
 
-        node_name = config[:chef_node_name] || config[:server_name]
+        @node_name = config[:chef_node_name] || config[:server_name]
 
-        puts ui.color("Creating machine #{node_name}", :cyan)
+        puts ui.color("Creating machine #{@node_name}", :cyan)
 
-        server = connection.servers.create({
-          :name => node_name,
-          :dataset => config[:dataset],
-          :package => config[:package]
-        }.merge(joyent_metadata))
+        server = connection.servers.create(server_creation_options)
 
         puts ui.color("Waiting for Server to be Provisioned", :magenta)
         server.wait_for { print "."; ready? }
@@ -164,7 +167,7 @@ class Chef
             tags << k
             tags << v
           end
-          puts ui.color("Updated tags for #{node_name}", :cyan)
+          puts ui.color("Updated tags for #{@node_name}", :cyan)
           puts ui.list(tags, :uneven_columns_across, 2)
         else
           puts ui.color("No user defined in knife config for provision tagging -- continuing", :magenta)
@@ -176,7 +179,7 @@ class Chef
         msg_pair("State", server.state)
         msg_pair("Type", server.type)
         msg_pair("Dataset", server.dataset)
-        msg_pair("IP's", server.ips.join(" "))
+        msg_pair("IPs", server.ips.join(" "))
         msg_pair("JSON Attributes",config[:json_attributes]) unless config[:json_attributes].empty?
 
         puts ui.color("Waiting for server to fully initialize...", :cyan)
@@ -263,6 +266,16 @@ class Chef
 
       private
 
+      def server_creation_options
+        o = {
+            :name => @node_name,
+            :dataset => config[:dataset],
+            :package => config[:package]
+        }.merge!(joyent_metadata)
+        o.merge!(:networks => config[:networks]) if config[:networks]
+        o
+      end
+
       def validate_server_name
         # add some validation here ala knife-ec2
         unless config[:server_name] || config[:chef_node_name]

data/lib/chef/knife/joyent_server_delete.rb

@@ -25,7 +25,7 @@ class Chef
         msg("State", server.state)
         msg("Type", server.type)
         msg("Dataset", server.dataset)
-        msg("IP's", server.ips.join(" "))
+        msg("IPs", server.ips.join(" "))
        
         unless server
           puts ui.error("Unable to locate server: #{id}")

data/lib/knife-joyent/version.rb

@@ -1,3 +1,3 @@
 module KnifeJoyent
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knife-joyent
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-23 00:00:00.000000000 Z
+date: 2013-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: 1.12.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: 1.12.1
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -69,6 +69,7 @@ extra_rdoc_files:
 - LICENSE
 files:
 - .gitignore
+- CHANGES.md
 - Gemfile
 - LICENSE
 - README.md
@@ -80,6 +81,7 @@ files:
 - lib/chef/knife/joyent_key_add.rb
 - lib/chef/knife/joyent_key_delete.rb
 - lib/chef/knife/joyent_key_list.rb
+- lib/chef/knife/joyent_network_list.rb
 - lib/chef/knife/joyent_server_create.rb
 - lib/chef/knife/joyent_server_delete.rb
 - lib/chef/knife/joyent_server_list.rb
@@ -122,3 +124,4 @@ signing_key:
 specification_version: 3
 summary: Joyent CloudAPI Support for Chef's Knife Command
 test_files: []
+has_rdoc: true