knife-gandi 0.2.0

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+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.

data/README.rdoc

@@ -0,0 +1,82 @@
+= Knife Gandi
+
+= DESCRIPTION:
+
+This plugin gives knife the ability to create, bootstrap, and manage servers on the Gandi Hosting platform.
+
+= INSTALLATION:
+
+This plugin is distributed as a Ruby Gem. To install it, run:
+
+    gem install knife-gandi
+
+Depending on your system's configuration, you may need to run this command with root privileges.
+
+= CONFIGURATION:
+
+In order to communicate with the Gandi Hosting API you will have to tell Knife about your API Key.  The easiest way to accomplish this is to create some entries in your <tt>knife.rb</tt> file:
+
+    knife[:gandi_api_key]  = "Your Gandi API Key"
+
+If your knife.rb file will be checked into a SCM system (ie readable by others) you may want to read the values from environment variables:
+
+    knife[:gandi_api_key] = "#{ENV['GANDI_API_KEY']}"
+
+You also have the option of passing your Gandi API Key into the individual knife subcommands using <tt>-K</tt> (or <tt>--gandi-api-key</tt>) command option
+
+    # provision a new 1GB Ubuntu 10.04 webserver
+    knife gandi server create 'role[webserver]' -I 23 -M 1024 -K "Your Gandi API Key"
+
+
+Additionally the following options may be set in your `knife.rb`:
+
+* template_file
+
+= SUBCOMMANDS:
+
+This plugin provides the following Knife subcommands.  Specific command options can be found by invoking the subcommand with a <tt>--help</tt> flag
+
+== knife gandi server create
+
+Provisions a new server in the Gandi Hosting platform and then perform a Chef bootstrap (using the SSH protocol).  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 (provided by the provisioning). It is primarily intended for Chef Client systems that talk to a Chef server. By default the server is bootstrapped using the {ubuntu10.04-gems}[https://github.com/opscode/chef/blob/master/chef/lib/chef/knife/bootstrap/ubuntu10.04-gems.erb] template.  This can be overridden using the <tt>-d</tt> or <tt>--template-file</tt> command options.
+
+Gandi server images have the root account enabled by default. When a server instance is created, a user with the credentials you provide is created. This account does not have sudo enabled, therefore the root account will alway be used to bootstrap Chef. For security reasons, it is recommended that you enable sudo for some user account then disable the root account once the create command returns.
+
+Make sure your Gandi account has sufficient resources in order to create a server.
+
+The Gandi Hosting platform will always try to recycle any IP address previously released from a server created using your Gandi account. Note that if you do not remove that IP address' fingerprint from ~/.ssh/known_hosts, you will get a 'could not connect'/Net::SSH::HostKeyMismatch Warning during the bootstrap phase and the bootstrap phase will be skipped. You can disable the host key check in your ssh settings, know the security implications before doing that.
+
+== knife gandi server delete
+
+Deletes an existing server in the currently configured Gandi account.  Please note - this does not delete the associated node and client objects from the Chef server.
+
+== knife gandi server list
+
+Outputs a list of all servers in the currently configured Gandi account.  Please note - this shows all instances associated with the account, some of which may not be currently managed by the Chef server.
+
+== knife gandi datacenter list
+
+Outputs a list of all available datacenters.  This data can be useful when choosing a datacenter id to pass to the <tt>knife gandi server create</tt> subcommand.
+
+== knife gandi image list
+
+Outputs a list of all available images available to the currently configured Gandi account.  An image is a collection of files used to create or rebuild a server. Gandi provides a number of pre-built OS images by default.  This data can be useful when choosing an image id to pass to the <tt>knife gandi server create</tt> subcommand.
+
+
+= LICENSE:
+
+Author:: Maxime Liron (<maximeliron@gmail.com>)
+Copyright:: Copyright (c) 2009-2011 Maxime Liron
+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.

data/lib/chef/knife/gandi_datacenter_list.rb

@@ -0,0 +1,70 @@
+#
+# Author:: Maxime Liron (<maximeliron@gmail.com>)
+# Copyright:: Copyright (c) 2011 Maxime Liron
+# 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'
+
+class Chef
+  class Knife
+    class GandiDatacenterList < Knife
+
+      deps do
+        require 'knife-gandi'
+        require 'knife-gandi/plugin_helper'
+        require 'xmlrpc/client'
+      end
+
+      banner "knife gandi datacenter list (options)"
+
+      option :gandi_api_key,
+        :short => "-K KEY",
+        :long => "--gandi-api-key KEY",
+        :description => "Your Gandi API key",
+        :proc => Proc.new { |key| Chef::Config[:knife][:gandi_api_key] = key }
+        
+      attr_reader :connection, :api_key
+
+      def run
+        # Unsual to extend here but enables 'plugin_helper' to be require'd lazily
+        extend KnifeGandi::PluginHelper
+        $stdout.sync = true
+        
+        # Necessary changes to xmlrpc's defaults, prevent warnings from showing up in prompt
+        suppress_warnings do
+          XMLRPC::Config.const_set(:ENABLE_NIL_PARSER, true)
+        end
+        
+        @connection = XMLRPC::Client.new2(KnifeGandi::API_ENDPOINT_URL)
+        @api_key    = Chef::Config[:knife][:gandi_api_key] || config[:gandi_api_key]
+        
+        server_list = [
+          ui.color('ID', :bold),
+          ui.color('Name', :bold),
+          ui.color('Country', :bold)
+        ]
+        
+        connection.call('datacenter.list', api_key).each do |server|
+          server_list << server['id'].to_s
+          server_list << server['name']
+          server_list << server['country']
+        end
+        
+        puts ui.list(server_list, :columns_across, 3)
+      end
+    end # GandiServerList
+  end
+end

data/lib/chef/knife/gandi_image_list.rb

@@ -0,0 +1,100 @@
+#
+# Author:: Maxime Liron (<maximeliron@gmail.com>)
+# Copyright:: Copyright (c) 2011 Maxime Liron
+# 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'
+
+class Chef
+  class Knife
+    class GandiImageList < Knife
+
+      deps do
+        require 'knife-gandi'
+        require 'knife-gandi/plugin_helper'
+        require 'xmlrpc/client'
+      end
+
+      banner "knife gandi image list (options)"
+
+      option :gandi_api_key,
+        :short => "-K KEY",
+        :long => "--gandi-api-key KEY",
+        :description => "Your Gandi API key",
+        :proc => Proc.new { |key| Chef::Config[:knife][:gandi_api_key] = key }
+        
+      option :gandi_datacenter_id,
+        :short => "-D ID",
+        :long => "--gandi-datacenter-id ID",
+        :description => "Filter using a specific datacenter ID",
+        :proc => Proc.new { |d| Chef::Config[:knife][:gandi_datacenter_id] = d.to_i }
+        
+      option :gandi_os_arch_32,
+        :short => "--32",
+        :description => "List only 32 bit images",
+        :boolean => true,
+        :proc => Proc.new { |d| Chef::Config[:knife][:gandi_os_arch] = 'x86-32' }
+        
+      option :gandi_os_arch_64,
+        :short => "--64",
+        :description => "List only 64 bit images",
+        :boolean => true,
+        :proc => Proc.new { |d| Chef::Config[:knife][:gandi_os_arch] = 'x86-64' }
+        
+      attr_reader :connection, :api_key
+      
+      def run
+        # Unsual to extend here but enables 'plugin_helper' to be require'd lazily
+        extend KnifeGandi::PluginHelper
+        $stdout.sync = true
+        
+        # Necessary changes to xmlrpc's defaults, prevent warnings from showing up in prompt
+        suppress_warnings do
+          XMLRPC::Config.const_set(:ENABLE_NIL_PARSER, true)
+          XMLRPC::Config.const_set(:ENABLE_NIL_CREATE, true)
+        end
+        
+        @connection = XMLRPC::Client.new2(KnifeGandi::API_ENDPOINT_URL)
+        @api_key    = Chef::Config[:knife][:gandi_api_key] || config[:gandi_api_key]
+        
+        raise "No Gandi API key was specified" unless api_key
+
+        image_list = [ 
+          ui.color('ID', :bold), 
+          ui.color('Name', :bold), 
+          ui.color('Arch', :bold),
+          ui.color('Datacenter_id', :bold)
+        ]
+        
+        # Filter the result set
+        filters = { 
+          :sort_by => 'label', 
+          :datacenter_id => Chef::Config[:knife][:gandi_datacenter_id] || nil,
+          :os_arch  => Chef::Config[:knife][:gandi_os_arch] || nil
+        }
+        
+        connection.call('image.list', api_key, filters).each do |image|
+          image_list << image['id'].to_s
+          image_list << ui.color(image['label'], :bold)
+          image_list << image['os_arch']
+          image_list << image['datacenter_id'].to_s
+        end
+        
+        puts ui.list(image_list, :columns_across, 4)
+      end
+    end
+  end
+end

data/lib/chef/knife/gandi_server_create.rb

@@ -0,0 +1,327 @@
+#
+# Author:: Maxime Liron (<maximeliron@gmail.com>)
+# Copyright:: Copyright (c) 2011 Maxime Liron
+# 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'
+
+class Chef
+  class Knife
+    class GandiServerCreate < Knife
+
+      deps do
+        require 'knife-gandi'
+        require 'knife-gandi/plugin_helper'
+        require 'xmlrpc/client'
+        require 'chef/knife/bootstrap'
+        require 'resolv'
+        Chef::Knife::Bootstrap.load_deps
+      end
+
+      banner "knife gandi server create (options)"
+
+      option :memory,
+        :short => "-M MEMORY",
+        :long => "--memory MEMORY",
+        :description => "The amount of memory (ram) of server",
+        :proc => Proc.new { |f| Chef::Config[:knife][:memory] = f.to_i }
+      
+      option :cores,
+        :short => "-C CORES",
+        :long => "--cores CORES",
+        :description => "The number of cores (cpu) of server",
+        :proc => Proc.new { |f| Chef::Config[:knife][:cores] = f.to_i }
+          
+      option :bandwidth,
+        :short => "-B BANDWIDTH",
+        :long => "--bandwidth BANDWIDTH",
+        :description => "The amount of bandwidth (network) of server (optional)",
+        :proc => Proc.new { |f| Chef::Config[:knife][:bandwidth] = f.to_i }
+        
+
+      option :ip_version,
+        :short => "-W VERSION",
+        :long => "--ip-version VERSION",
+        :description => "The version of the IP protocol",
+        :proc => Proc.new { |f| Chef::Config[:knife][:ip_version] = f.to_i }
+
+      option :image_id,
+        :short => "-I IMAGE_ID",
+        :long => "--image-id IMAGE_ID",
+        :description => "The image id of the desired server image",
+        :proc => Proc.new { |i| Chef::Config[:knife][:image_id] = i.to_i }
+        
+      option :disk_name,
+        :short => "-H NAME",
+        :long => "--disk-name NAME",
+        :description => "The name of the server's system disk. default: {server name}_disk",
+        :proc => Proc.new { |i| Chef::Config[:knife][:disk_name] = i }
+        
+      option :datacenter_id,
+        :short => "-D DATACENTER_ID",
+        :long => "--datacenter-id DATACENTER_ID",
+        :description => "The datacenter's id in which the server will be created",
+        :proc => Proc.new { |i| Chef::Config[:knife][:datacenter_id] = i.to_i }
+
+      option :server_name,
+        :short => "-S NAME",
+        :long => "--server-name NAME",
+        :description => "The server name"
+
+      option :chef_node_name,
+        :short => "-N NAME",
+        :long => "--node-name NAME",
+        :description => "The Chef node name for your new node, defaults to server name"
+
+      option :login,
+        :short => "-x USERNAME",
+        :long => "--login USERNAME",
+        :description => "The login for the server"
+
+      option :password,
+        :short => "-P PASSWORD",
+        :long => "--password PASSWORD",
+        :description => "The password for the server"
+
+      option :gandi_api_key,
+        :short => "-K KEY",
+        :long => "--gandi-api-key KEY",
+        :description => "Your Gandi API key",
+        :proc => Proc.new { |key| Chef::Config[:knife][:gandi_api_key] = key }
+
+      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 :distro,
+        :short => "-d DISTRO",
+        :long => "--distro DISTRO",
+        :description => "Bootstrap a distro using a template",
+        :proc => Proc.new { |d| Chef::Config[:knife][:distro] = d },
+        :default => "ubuntu10.04-gems"
+
+      option :use_sudo,
+        :long => "--sudo",
+        :description => "Execute the bootstrap via sudo",
+        :boolean => true,
+        :default => true
+
+      option :template_file,
+        :long => "--template-file TEMPLATE",
+        :description => "Full path to location of template to use",
+        :proc => Proc.new { |t| Chef::Config[:knife][:template_file] = t },
+        :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(/[\s,]+/) },
+        :default => []
+      
+      attr_reader :connection, :api_key
+
+      def run
+        # Unsual to extend here but enables 'plugin_helper' to be require'd lazily (in deps)
+        extend KnifeGandi::PluginHelper
+        $stdout.sync = true
+        
+        # Necessary changes to xmlrpc's defaults, prevent warnings from showing up in prompt
+        suppress_warnings do
+          XMLRPC::Config.const_set(:ENABLE_NIL_PARSER, true)
+          XMLRPC::Config.const_set(:ENABLE_NIL_CREATE, true)
+        end
+        
+        # The connection used to communicate with the Gandi API throught this command invokation
+        @connection = XMLRPC::Client.new2(KnifeGandi::API_ENDPOINT_URL)
+        @api_key    = Chef::Config[:knife][:gandi_api_key] || config[:gandi_api_key] || raise("Please provide an API key")
+        
+        print "\n"
+        
+        # Server spec
+        # Sent as a param to the Gandi API
+        # For mandatory params that were not passed in through the command line, ask for them interactively
+        # The code may try to validate given values but we expect the API will throw errors.
+        server_spec = Hash.new
+        
+        # Server Name
+        server_spec[:hostname]   = locate_config_value(:server_name)
+        server_spec[:hostname] ||= ui.ask('Name of the server: ') do |question| 
+          question.answer_type  = String
+        end
+        
+        # CPU Cores
+        server_spec[:cores]   = locate_config_value(:cores)
+        server_spec[:cores] ||= ui.ask('Number of CPU cores: ') do |question|
+          question.answer_type  = Integer
+          question.default      = 1
+          question.in           = 1..6
+        end
+        
+        # Memory
+        server_spec[:memory]   = locate_config_value(:memory)
+        server_spec[:memory] ||= ui.ask('Amount of memory (MB): ') do |question|
+          question.answer_type  = Integer
+          question.default      = 256
+          #  Make sure this is a valid memory value
+          question.validate     = lambda { |ans| ans.to_i.modulo(64) == 0 }
+          question.in           = 256..12288
+          question.responses[:not_valid] = "Your answer isn't valid (must be a valid memory value ex: 256, 512, 2048, ...)"
+        end
+        
+        # Network Bandwidth
+        bandwidth   = locate_config_value(:bandwidth)
+        bandwidth ||= ui.ask('Bandwidth (MB): ') do |question|
+          question.answer_type = Integer
+          question.default     = 5
+        end
+        server_spec[:bandwidth] = bandwidth * 1024
+        
+        # IP Version
+        server_spec[:ip_version]   = locate_config_value(:ip_version)
+        server_spec[:ip_version] ||= ui.ask('IP protocol version: ') do |question|
+          question.answer_type  = Integer
+          question.default      = 4
+          question.in           = [4, 6]
+        end
+        
+        # Datacenter
+        # TODO: Query the API and list the datacenters inline, there is only two of them currently.
+        server_spec[:datacenter_id]   = locate_config_value(:datacenter_id)
+        server_spec[:datacenter_id] ||= ui.ask('Datacenter id: ') do |question|
+          question.answer_type  = Integer
+        end
+        
+        # User Name
+        # WARN: The Gandi hosting platform will not allow use of 'root'
+        server_spec[:login]   = locate_config_value(:login)
+        server_spec[:login] ||= ui.ask('Username: ') do |question|
+          question.answer_type  = String
+          question.default      = 'admin'
+        end
+        
+        # User Password
+        server_spec[:password]   = locate_config_value(:password)
+        server_spec[:password] ||= ui.ask('Password: ') do |question|
+          question.answer_type  = String
+          question.validate     = /^[ -~]{8,64}$/
+        end
+        
+        # Server Image
+        # To create a server instance, Gandi requires a disk spec of the server's system disk
+        disk_spec = Hash.new
+        disk_spec[:datacenter_id] = server_spec[:datacenter_id]
+        disk_spec[:name] = locate_config_value(:disk_name) || "disk_#{server_spec[:hostname]}"
+        
+        server_image_id   = locate_config_value(:image_id)
+        server_image_id ||= ui.ask('Image id (see `knife gandi image list` command output): ') do |question|
+          question.answer_type = Integer
+        end
+        
+        # Lookup the server image
+        server_image = connection.call('image.info', api_key, server_image_id)
+
+        # Create the server
+        # 'vm.create_from' is a shortcut method that creates the vm, its system disk and network interface
+        # in one method call. It returns three operations, one describing each create operation.
+        create_operations   = connection.call('vm.create_from', api_key, server_spec, disk_spec, server_image['disk_id'])
+        vm_create_operation = create_operations.find { |op| op['type'] == 'vm_create' }
+
+        print "\n"
+        print ui.color("Creating the server.", :magenta)
+        
+        # Wait for it to be created to do stuff...
+        until_done(vm_create_operation) { print '.' }
+        
+        # Server is created, now get its specs
+        server = connection.call('vm.info', api_key, vm_create_operation['vm_id'])
+        # Server's public IP resource representation (IP address, reverse dns, ...). See Gandi API docs
+        public_ip_info = ip_objects_of(server, :type => 'public', :version => server_spec[:ip_version]).first
+        
+        
+        puts "\n"
+        puts "#{ui.color("Public DNS Name", :cyan)}: #{public_ip_info['reverse']}"
+        puts "#{ui.color("Public IP Address", :cyan)}: #{public_ip_info['ip']}"
+        puts "#{ui.color("Password", :cyan)}: #{server_spec[:password]}"
+
+        print "\n"
+        print ui.color("Waiting for sshd.", :magenta)
+
+        print(".") until tcp_test_ssh(public_ip_info['reverse']) { sleep @initial_sleep_delay ||= 10; puts("done") }
+        
+        # Now that we have SSH access, bootstrap Chef on the server 
+        # and hand over control to the Chef infrastructure
+        bootstrap_for_node(server_spec, server, public_ip_info['reverse']).run
+
+        puts "\n"
+        puts "#{ui.color("Instance ID", :cyan)}: #{server['id']}"
+        puts "#{ui.color("Name", :cyan)}: #{server['hostname']}"
+        puts "#{ui.color("Memory", :cyan)}: #{server['memory']}"
+        puts "#{ui.color("Cores", :cyan)}: #{server['cores']}"
+        puts "#{ui.color("Image", :cyan)}: #{server_image['label']}"
+        puts "#{ui.color("Public DNS Name", :cyan)}: #{public_ip_info['reverse']}"
+        puts "#{ui.color("Public IP Address", :cyan)}: #{public_ip_info['ip']}"
+        puts "#{ui.color("Password", :cyan)}: #{server_spec[:password]}"
+        puts "#{ui.color("Environment", :cyan)}: #{config[:environment] || '_default'}"
+        puts "#{ui.color("Run List", :cyan)}: #{config[:run_list].join(', ')}"
+      end
+      
+      # Test if an SSH deamon is listening.
+      # AKA: is my server up and running?
+      def tcp_test_ssh(hostname)
+        tcp_socket = TCPSocket.new(hostname, 22)
+        readable = IO.select([tcp_socket], nil, nil, 5)
+        if readable
+          Chef::Log.debug("sshd accepting connections on #{hostname}, banner is #{tcp_socket.gets}")
+          yield
+          true
+        else
+          false
+        end
+      rescue Errno::ETIMEDOUT
+        false
+      rescue Errno::ECONNREFUSED
+        sleep 2
+        false
+      ensure
+        tcp_socket && tcp_socket.close
+      end
+
+      def bootstrap_for_node(server_spec, server, fqdn)
+        bootstrap = Chef::Knife::Bootstrap.new
+        bootstrap.name_args = [fqdn]
+        bootstrap.config[:run_list] = config[:run_list]
+        bootstrap.config[:ssh_user] = 'root'
+        bootstrap.config[:ssh_password] = server_spec[:password]
+        bootstrap.config[:identity_file] = config[:identity_file]
+        bootstrap.config[:chef_node_name] = server[:chef_node_name] || "#{server['hostname']}_gandi-#{server['id']}"
+        bootstrap.config[:prerelease] = config[:prerelease]
+        bootstrap.config[:bootstrap_version] = locate_config_value(:bootstrap_version)
+        bootstrap.config[:distro] = locate_config_value(:distro)
+        # bootstrap will run as root...sudo (by default) also messes up Ohai on CentOS boxes
+        bootstrap.config[:use_sudo] = config[:use_sudo]
+        bootstrap.config[:template_file] = locate_config_value(:template_file)
+        bootstrap.config[:environment] = config[:environment]
+        bootstrap
+      end
+    end
+  end
+end

data/lib/chef/knife/gandi_server_delete.rb

@@ -0,0 +1,94 @@
+#
+# Author:: Maxime Liron (<maximeliron@gmail.com>)
+# Copyright:: Copyright (c) 2011 Maxime Liron
+# 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'
+
+class Chef
+  class Knife
+    class GandiServerDelete < Knife
+      
+      deps do
+        require 'knife-gandi'
+        require 'knife-gandi/plugin_helper'
+        require 'xmlrpc/client'
+      end
+      
+      banner "knife gandi server delete SERVER_ID (options)"
+
+      option :gandi_api_key,
+        :short => "-K KEY",
+        :long => "--gandi-api-key KEY",
+        :description => "Your Gandi API key",
+        :proc => Proc.new { |key| Chef::Config[:knife][:gandi_api_key] = key }
+
+      attr_reader :connection, :api_key
+        
+      def run
+        # Unsual to extend here but enables 'plugin_helper' to be require'd lazily
+        extend KnifeGandi::PluginHelper
+        $stdout.sync = true
+        
+        # Necessary changes to xmlrpc's defaults, prevent warnings from showing up in prompt
+        suppress_warnings do
+          XMLRPC::Config.const_set(:ENABLE_NIL_PARSER, true)
+          XMLRPC::Config.const_set(:ENABLE_NIL_CREATE, true)
+        end
+        
+        @connection = XMLRPC::Client.new2(KnifeGandi::API_ENDPOINT_URL)
+        @api_key    = Chef::Config[:knife][:gandi_api_key] || config[:gandi_api_key] || raise("Please provide an API key")
+        
+        server = connection.call('vm.info', api_key, @name_args[0].to_i)
+        
+        puts "\n"
+        puts "#{ui.color("Server ID", :cyan)}: #{server['id']}"
+        puts "#{ui.color("Name", :cyan)}: #{ui.color(server['hostname'], :bold)}"
+        puts "#{ui.color("Description", :cyan)}: #{server['description']}" if server['description']
+        puts "#{ui.color("Memory", :cyan)}: #{server['memory']}"
+        puts "#{ui.color("Cores", :cyan)}: #{server['cores']}"
+        puts "#{ui.color("Datacenter ID", :cyan)}: #{server['datacenter_id']}"
+        puts "#{ui.color("Image", :cyan)}: #{server['disks'].find{ |disk| disk['is_boot_disk'] }['label']}"
+        puts "#{ui.color("State", :cyan)}: #{server['state']}"
+        
+        raise "This server is being created, wait for this to end and try again" if server['state'] == 'being_created'
+
+        puts "\n"
+        puts "==============================================="
+        confirm("Do you really want to delete this server?")
+        
+        # Stop the server, the API requires a server to be halted before it can be deleted
+        unless (server['state'] == 'halted')
+          puts "\n"
+          print ui.color("Stopping server.", :magenta)
+          halt_operation = connection.call('vm.stop', api_key, server['id'])
+          until_done(halt_operation) { print '.' }
+        end
+        
+        vm_delete_operation = connection.call('vm.delete', api_key, server['id'])
+        
+        puts "\n\n"
+        print ui.color("Deleting server.", :magenta)
+        
+        until_done(vm_delete_operation) { print '.' }
+        
+        puts "\n\n"
+        ui.warn("Deleted server #{ui.color(server['id'], :bold)} named #{ui.color(server['hostname'], :bold)}")
+      end
+    end
+  end
+
+end

data/lib/chef/knife/gandi_server_list.rb

@@ -0,0 +1,89 @@
+#
+# Author:: Maxime Liron (<maximeliron@gmail.com>)
+# Copyright:: Copyright (c) 2011 Maxime Liron
+# 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'
+
+class Chef
+  class Knife
+    class GandiServerList < Knife
+
+      deps do
+        require 'knife-gandi'
+        require 'knife-gandi/plugin_helper'
+        require 'xmlrpc/client'
+      end
+
+      banner "knife gandi server list (options)"
+
+      option :gandi_api_key,
+        :short => "-K KEY",
+        :long => "--gandi-api-key KEY",
+        :description => "Your Gandi API key",
+        :proc => Proc.new { |key| Chef::Config[:knife][:gandi_api_key] = key }
+        
+      option :ip_version,
+        :short => "-W VERSION",
+        :long => "--ip-version VERSION",
+        :description => "The version of the IP protocol (4|6) displayed in the listings",
+        :proc => Proc.new { |f| Chef::Config[:knife][:ip_version] = f.to_i },
+        :default => 4
+
+      attr_reader :connection, :api_key
+        
+      def run
+        # Unsual to extend here but enables 'plugin_helper' to be require'd lazily
+        extend KnifeGandi::PluginHelper
+        $stdout.sync = true
+        
+        # Necessary changes to xmlrpc's defaults, prevent warnings from showing up in prompt
+        suppress_warnings do
+          XMLRPC::Config.const_set(:ENABLE_NIL_PARSER, true)
+        end
+        
+        @connection = XMLRPC::Client.new2(KnifeGandi::API_ENDPOINT_URL)
+        @api_key    = Chef::Config[:knife][:gandi_api_key] || config[:gandi_api_key] || raise("Please provide an API key")
+        
+        server_list = [
+          ui.color('ID', :bold),
+          ui.color('Hostname', :bold),
+          ui.color('Date Created', :bold),
+          ui.color('Cores', :bold),
+          ui.color('Memory', :bold),
+          ui.color('Image', :bold),
+          ui.color('State', :bold),
+          ui.color('Public IPs', :bold)
+        ]
+        
+        connection.call('vm.list', api_key).each do |server|
+          # Adds a some overhead but returns much more vm attributes including IPs and Image
+          server = connection.call('vm.info', api_key, server['id'])
+          server_list << server['id'].to_s
+          server_list << server['hostname']
+          server_list << server['date_created'].to_date.to_s
+          server_list << server['cores'].to_s
+          server_list << server['memory'].to_s + 'mb'
+          server_list << server['disks'].find{ |disk| disk['is_boot_disk'] }['label']
+          server_list << server['state']
+          server_list << public_ips_of(server, :version => locate_config_value(:ip_version)).join(', ')
+        end
+      
+        puts ui.list(server_list, :columns_across, 8)
+      end
+    end # GandiServerList
+  end
+end

data/lib/knife-gandi.rb

@@ -0,0 +1,6 @@
+require 'knife-gandi/version'
+require 'knife-gandi/plugin_helper'
+
+module KnifeGandi
+  API_ENDPOINT_URL = "https://rpc.gandi.net/xmlrpc/2.0/"
+end

data/lib/knife-gandi/plugin_helper.rb

@@ -0,0 +1,63 @@
+module KnifeGandi
+  module PluginHelper
+    
+    # Keeps the vm's warnings out of $stdout.
+    # Helpful when changing the value of a constant.
+    def suppress_warnings
+      original_verbosity = $VERBOSE
+      $VERBOSE = nil
+      result = yield
+      $VERBOSE = original_verbosity
+      return result
+    end
+    
+    def locate_config_value(key)
+      key = key.to_sym
+      Chef::Config[:knife][key] || config[key]
+    end
+    
+    def config_has_value?(key)
+      key = key.to_sym
+      Chef::Config[:knife].has_key?(key) || config.has_key?(key)
+    end
+    
+    def until_done(operation)
+      while operation['step'] != 'DONE' 
+        operation = connection.call('operation.info', api_key, operation['id'])
+        yield
+        sleep 2
+      end
+    end
+    
+    def public_ips_of(server, opts={})
+      options = opts.merge({:type => 'public'})
+      public_ips = ip_objects_of(server, options)
+      public_ips.collect { |ip| ip['ip'] }
+    end
+    
+    def public_reverses_of(server, opts={})
+      options = opts.merge({:type => 'public'})
+      public_ips = ip_objects_of(server, options)
+      public_ips.collect { |ip| ip['reverse'] }
+    end
+    
+    # Returns the public IP Resource objects sent from the server.
+    # Look up their representation in the Gandi API docs.
+    def ip_objects_of(server, opts={})
+      # Server has n ifaces which hold 2 IPs (IPv4 and IPv6)
+      public_ifaces = server['ifaces']
+      if opts.has_key?(:type)
+        public_ifaces = public_ifaces.find_all { |iface| iface['type'] == 'public' }
+      end
+      
+      public_ips = public_ifaces.collect_concat { |iface| iface['ips'] }
+      if opts.has_key?(:version)
+        # Filter IP version (4|6)
+        public_ips = public_ips.find_all { |ip| ip['version'] == opts[:version] }
+      end
+      
+      public_ips
+    end
+    
+  end # EOF PluginHelper
+end

data/lib/knife-gandi/version.rb

@@ -0,0 +1,3 @@
+module KnifeGandi
+  VERSION = "0.2.0"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: knife-gandi
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Maxime Liron
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-11 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: net-ssh
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.1.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: net-ssh-multi
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.1
+  type: :runtime
+  version_requirements: *id002
+description: Gandi Hosting Support for Chef's Knife Command
+email: maximeliron@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+files: 
+- LICENSE
+- README.rdoc
+- lib/chef/knife/gandi_datacenter_list.rb
+- lib/chef/knife/gandi_image_list.rb
+- lib/chef/knife/gandi_server_create.rb
+- lib/chef/knife/gandi_server_delete.rb
+- lib/chef/knife/gandi_server_list.rb
+- lib/knife-gandi/plugin_helper.rb
+- lib/knife-gandi/version.rb
+- lib/knife-gandi.rb
+has_rdoc: true
+homepage: http://wiki.opscode.com/display/chef
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.1
+signing_key: 
+specification_version: 3
+summary: Gandi Hosting Support for Chef's Knife Command
+test_files: []
+