ganeti_client 0.0.1 → 0.0.2

data/README

@@ -1,8 +1,3 @@
-== License
-    
-    This Ruby Ganeti Client is release under AGPL licence (http://www.gnu.org/licenses/agpl-3.0.html)
-
-
 == Todo
 
     1. Manually test the following methods + fix when bugs found
@@ -17,7 +12,6 @@
         1.9.    instance_activate_disks
         1.10.   instance_create_tags
         1.11.   instance_delete_tags
-        1.12.   job_get
         1.13.   job_delete
         1.14.   node_evaluate
         1.15.   node_migrate
@@ -61,6 +55,7 @@
     info.name
     => "hostname"
 
+
 == Contributing
 
     1. Fork the project
@@ -69,6 +64,18 @@
     4. Send a pull request
 
 
+== Author
+    
+    Michaël Rigart
+
+
+== License
+    
+    This Ruby Ganeti Client is release under AGPL licence (http://www.gnu.org/licenses/agpl-3.0.html)
+
+
+
+
 
 
 

data/lib/ganeti_client/client.rb

@@ -1,23 +1,61 @@
+# The program makes use of the Google Ganeti RAPI to access diffrent resources. 
+#
+# The Client is mainly developed for usage with the Ganeti RAPI version 2
+# 
+# The protocol used is JSON over HTTP designed afther the REST principle. HTTP Basic authentication as per RFC2617 is supported
+#
+# A few generic refered parameter types and the values they allow:
+#   
+#   bool:
+#       A boolean option will accept 1 or 0 as numbers but not i.e. True or False
+#
+# A few parameter mean the same thing accross all resources which implement it:
+#
+#   bulk:
+#       Bulk-mode means that for the resources which usually return just a list of child resources (e.g. /2/instances which returns just instance names), 
+#       the output will instead contain detailed data for all these subresources. This is more efficient than query-ing the sub-resources themselves.
+#
+#   dry-run:
+#       The boolean dry-run argument, if provided and set, signals to Ganeti that the job should not be executed, only the pre-execution checks will be done.
+#       This is useful in trying to determine (without guarantees though, as in the meantime the cluster state could have changed) if the operation 
+#       is likely to succeed or at least start executing.
+#
+#   force:
+#       Force operation to continue even if it will cause the cluster to become inconsistent (e.g. because there are not enough master candidates).
+#
+# Author::    Michaël Rigart  (mailto:michael@netronix.be)
+# Copyright:: Copyright (c) 2010 Michaël Rigart
+# License::   Distributes under AGPL Licence
+
 module GanetiClient
+ 
+    # This class contains all active resources available in Ganeti RAPI
     class Client
 
-        attr_accessor :conn, :headers, :version, :show_response
+        attr_accessor :host, :username, :password, :version, :show_response
 
+        # Create the client object
+        # 
+        # Parameters:
+        #   host: hostname and port
+        #   username: username that has access to RAPI
+        #   password: password of the user provided
+        #   show_response: show response data (optional) 
         def initialize(host, username, password, show_response = false)
-            self.show_output = show_output
-            uri = URI.parse(host)
-
-            self.conn = Net::HTTP.new(uri.host, uri.port)
-            self.conn.use_ssl = (uri.scheme == "http")? false : true
-
-            self.headers = authenticate(username, password)
+            self.host = host
+            self.username = username
+            self.password = password
+            
+            self.show_response = show_response
 
-            self.version = self.get_version
+            self.version = self.version_get
         end
 
 
-        # Cluster information resource
-        # Returns cluster information
+        # Get the cluster information
+        #
+        # Return:
+        #   GanetiInfo object
         def info_get
             url = get_url("info")
             response_body = JSON.parse(send_request("GET", url))
@@ -28,7 +66,9 @@ module GanetiClient
         end
 
         # Redistrite configuration to all nodes
-        # Redistribute configuration to all nodes. The result will be a job id.
+        # 
+        # Return:
+        #   job id.
         def redistribute_config
             url = get_url("redistribute-config")
             response_body = send_request("PUT", url)
@@ -36,9 +76,13 @@ module GanetiClient
             return response_body
         end
 
-        # The instance resource
-        # Returns a list of all available instances
-        # If the optional bool bulk argument is provided and set to a true value (i.e ?bulk=1), the output contains detailed information about instances as a list.
+        # Get all instances on the cluster
+        #
+        # Parameters:
+        #   bulk: 0|1 (optional)
+        #
+        # Return:
+        #   Array of all available instances. The array items contain a GanetiInstance object
         def instances_get(bulk = 0)
             url = get_url("instances", {"bulk" => bulk})
             response_body = JSON.parse(send_request("GET", url))
@@ -51,23 +95,57 @@ module GanetiClient
             return list
         end
 
-        # Creates an instance
+        # Create an instance
         # If the options bool dry-run argument is provided, the job will not be actually executed, only the pre-execution checks will be done. 
         # Query-ing the job result will return, in boty dry-run and normal case, the list of nodes selected for the instance
-        # Returns: a job ID that can be used later for polling
         #
-        # Example of instance info:
-        #   
+        # Build parameters dict, optional parameters need to be
+        # excluded to not cause issues with rapi.
+        #  
+        # Example:
+        #       info = {
+        #               'hypervisor'    => 'kvm'    ,               'disk_template' => 'plain',
+        #               'pnode'         => 'node.netronix.be',      'name'          => 'vm1.netronix.be',   'os'    => 'debootstrap+lucid', 
+        #               'vcpus'         => '4',                     'memory'        => '4096',              'disks' => ['25600'],
+        #               'kernel-path'   => '/boot/vmlinuz-2.6-kvmU'
+        #              }
+        #
+        # Parameters:
+        #   info: hash of data needed for the instance creation
+        #   dry_run: 0|1 (optional)
+        #
+        # Return:
+        #   job_id
         def instance_create(info, dry_run = 0)
+            params = {
+                        'hypervisor'    => info['hypervisor'],  'disk_template' => info['disk_template'],
+                        'pnode'         => info['pnode'],       'name'          => info['iname'],           'os'    => info['os'], 
+                        'vcpus'         => info['vcpus'],       'memory'        => info['memory'],          'disks' => [info['size']]
+                    }
+
+            # Add secondary node
+            params['snode'] = info['snode'] if info['disk_template'] == 'drbd' && info['snode']
+
+            # Add PVM parameters
+            if info['hypervisor'] 
+                params['kernel_path'] = info['kernel_path'] if info['kernel_path']
+                params['initrd_path'] = info['initrd_path'] if info['initrd_path']
+            end
+            
             url = get_url("instances", {"dry-run" => dry_run})
-            body = JSON.generate(info)
+            body = JSON.generate(params)
             response_body = send_request("POST", url, body)
 
             return response_body
         end
 
-        # Instance-specific resource
-        # Returns information about an instance, similar to the bulk output from the instance list
+        # Get instance specific information, similar to the bulk output from the instance list
+        #
+        # Parameters:
+        #   name: name of the instance
+        #
+        # Return
+        #   GanetiInstance object
         def instance_get(name)
             url = get_url("instances/#{name}")
             response_body = JSON.parse(send_request("GET", url))
@@ -77,19 +155,29 @@ module GanetiClient
             return GanetiInstance.new(response_body)
         end
 
-        # Instance-specific resource
-        # Deletes an instance
-        # It supports the dry-run argument
-        def instance_delete(name, dry_run)
+        # Delete a specific instance
+        # 
+        # Parameters:
+        #   name: name of the instance
+        #   dry_run: 0|1 (optional)
+        #
+        # Return:
+        #   ?
+        def instance_delete(name, dry_run = 0)
             url = get_url("instances/#{name}", {"dry-run" => dry_run})
             response_body = send_request("DELETE", url)
 
             return response_body 
         end
 
-        # Requests detailed information about an instance. 
-        # An optional parameter, static (bool), can be set to return only static information from the configuration without querying the instance's nodes
-        # The result will be a job id
+        # Get detailed information about an instance. Static parameter can be set to return only static information from the configuration without querying the instance's nodes
+        #
+        # Parameters:
+        #   name: name of the instance
+        #   static: 0|1 (optional)
+        #
+        # Return:
+        #   job id
         def instance_get_info(name, static = 0)
             url = get_url("instances/#{name}/info", {"static" => static})
             response_body = send_request("GET", url)
@@ -97,8 +185,7 @@ module GanetiClient
             return response_body
         end
 
-        # Reboots URI for an instance
-        # Reboots the instance
+        # Reboot a specific instance
         # The URI takes optional type=soft|hard|full and ignore_secondaries=0|1 parameters
         # 
         # type defines the reboot type. 
@@ -107,86 +194,130 @@ module GanetiClient
         #   full is like hard but also recreates the configuration from ground up as if you would have don a gnt-instance shutdown and gnt-instance start on it
         #
         # it supports the dry-run argument
+        #
+        # Parameters:
+        #   name: name of the instance
+        #   type: soft|hard|full (optional)
+        #   ignore_secondaries: 0|1 (optional)
+        #   dry_run: 0|1 (optional)
+        #
+        # Return:
+        #   ?
         def instance_reboot(name, type = "soft", ignore_secondaries = 0, dry_run = 0)
             url = get_url("instances/#{name}/reboot", {"type" => type, "ignore_secondaries" => ignore_secondaries, "dry_run" => 0})
-            response_body = JSON.parse(send_request("POST", url))
-
-            create_class("GanetiInstanceReboot")
+            response_body = send_request("POST", url)
 
-            return GanetiIntanceReboot.new(response_body)
+            return response_body
         end
 
 
-        # Instance shutdown URI
-        # Shutdowns an instance
-        # It supports the dry-run argument
+        # Shutdown an instance
+        # 
+        # Parameters:
+        #   name: name of the instance
+        #   dry_run: 0|1 (optional)
+        #
+        # Return:
+        #   ?
         def instance_shutdown(name, dry_run = 0)
             url = get_url("instances/#{name}/shutdown", {"dry-run" => dry_run})
-            response_body = JSON.parse(send_request("PUT", url))
-
-            create_class("GanetiInstanceShutdown")
+            response_body = send_request("PUT", url)
 
-            return GanetiInstanceShutdown.new(response_body)
+            return response_body 
         end      
 
-        # Instance startup URI
         # Startup an instance
         # The URI takes an optional force=1|0 parameter to start the instance even if secondary disks are failing
-        # It supports the dry-run argument
+        #
+        # Parameters:
+        #   name: name of the instance
+        #   force: 0|1 (optional)
+        #   dry_run: 0|1 (optional)
+        #
+        # Return:
+        #   ?
         def instance_startup(name, force = 0, dry_run=0)
             url = get_url("instances/#{name}/startup", {"force" => force, "dry-run" => dry_run})
             body = "" # force parameter
             response_body = send_request("PUT", url, body)
 
-            create_class("GanetiInstanceStartup")
-
-            return GanetiInstanceStartup.new(response_body)
+            return response_body
         end
 
         # Install the operating system again
-        # Takes the parameters os (OS template name) and nostartup (bool)
-        def instance_reinstall(name, os_name, nostartup)
+        # 
+        # Parameters:
+        #   name: name of the instance
+        #   os_name: name of the os
+        #   nostartup: 0|1 (optional)
+        #
+        # Return:
+        #   ?
+        def instance_reinstall(name, os_name, nostartup = 0)
             url = get_url("instances/#{name}/reinstall", {"os" => os_name, "nostartup" => nostartup})
             response_body = send_request("POST", url)
 
-            create_class("GanetiInstanceReinstall")
-
-            return GanetiInstanceReinstall.new(response_body)
+            return response_body
         end
 
         # Replaces disks on an instance
         # Takes the parameters mode (one of replace_on_primary, replace_on_secondary or replace_auto), disks (comma seperated list of disk indexes), remote_node and iallocator
         # Either remote_node or iallocator needs to be defined when using mode=replace_new_secondary
         # mode is a mandatory parameter. replace_auto tries to determine the broken disk(s) on its own and replacing it
+        #
+        # Parameters:
+        #   name: name of the instance
+        #   mode replace_on_primary|replace_on_secondary|replace_auto (optional)
+        #   ialllocator:
+        #   remote_node:
+        #   disks: comma seperated list of disk indexes
+        #
+        # Return:
+        #   ?
         def instance_replace_disks(name, mode = "replace_auto", iallocator  = "", remote_node = "", disks = "")
             url = get_url("instances/#{name}/replace-disks", {"mode" => mode, "iallocator" => iallocator, "remote_node" => remote_node, "disks" => disks})
             response_body = send_request("POST", url)
 
-            return "?"
+            return response_body
         end
 
         # Activate disks on an instance
         # Takes the bool parameter ignore_size. When set ignore the recorded size (useful for forcing activation when recoreded size is wrong)
+        #
+        # Parameters:
+        #   name: name of the instance
+        #   ignore_size: 0|1 (optional)
+        #
+        # Return:
+        #   ?
         def intance_activate_disks(name, ignore_size = 0)
             url = get_url("instances/#{name}/activate-disks", {"ignore_size" => ignore_size})
             response_body = send_request("PUT", url)
 
-            return "?"
+            return response_body
         end
 
         # Deactivate disks on an instance
-        # Takes no parameters
+        # 
+        # Parameters:
+        #   name: name of the instance
+        #
+        # Return:
+        #   ?
         def instance_deactivate_disks(name)
             url = get_url("instances/#{name}/deactivate-disks")
             response_body = send_request("PUT", url)
 
-            return "?"
+            return response_body
         end
 
         # Returns a list of tags
         #
-        # Example:
-        #   ["tag1", "tag2", "tag3"]
+        # Parameters:
+        #   name: name of the instance
+        #
+        # Return:
+        #   Array of tags
         def instance_get_tags(name)
             url = get_url("instances/#{name}/tags")
             response_body = JSON.parse(send_request("GET", url))
@@ -195,28 +326,41 @@ module GanetiClient
         end
        
         # Add a set of tags
-        # The request as a list of strings shoud be PUT tot this URI. The result will be a job id
-        # It supports the dry-run argument
-        def instance_create_tags(name, dry_run = 0)
-            url = get_url("instances/#{name}/tags", {"dry-run" => dry_run})
+        #
+        # Parameters:
+        #   name: name of the instance
+        #   tags: Array of tags
+        #   dry_run: 0|1 (optional)
+        #
+        # Return:
+        #   ?
+        def instance_create_tags(name, tags, dry_run = 0)
+            url = get_url("instances/#{name}/tags", {"tags" => tags, "dry-run" => dry_run})
             response_body = send_request("PUT", url)
 
             return response_body
         end
 
-        # Delete a tag
-        # In order to delete a set of tags, the DELETE request sould be addressed to URI LIKE:
-        #   /tags?tag=[tag]&tag=[tag]
-        # It supports the dry-run argument
-        def instance_delete_tags(name, dry_run = 0)
-            url = get_url("instances/#{name}/tags", {"dry-run" => dry_run})
+        # Delete (a) tag(s) on an instance
+        # 
+        # Parameters:
+        #   name: name of the instance
+        #   tags: Array of tags
+        #   dry_run: 0|1 (optional)
+        #
+        # Return:
+        #   ?
+        def instance_delete_tags(name, tags, dry_run = 0)
+            url = get_url("instances/#{name}/tags", {"tags" => tags, "dry-run" => dry_run})
             response_body = send_request("DELETE", url)
 
-            return "?"
+            return response_body
         end
 
         # Returns a dictionary of jobs
-        # Returns: a dictionary with jobs id and uri
+        # 
+        # Return:
+        #   Array of GanetiJob objects
         def jobs_get
             url = get_url("jobs")
             response_body = JSON.parse(send_request("GET", url))
@@ -287,11 +431,17 @@ module GanetiClient
         end
 
         # Cancel a not-yet-started job
+        #
+        # Parameters:
+        #   job_id: id of a job
+        #
+        # Return:
+        #   ?
         def job_delete(job_id)
             url = get_url("jobs/#{job_id}")
             response = send_request("DELETE", url)
 
-            return "?"
+            return response_body
         end
 
         # Nodes resource
@@ -331,7 +481,7 @@ module GanetiClient
            url = get_url("nodes/#{name}/evacuate", {"iallocator" => iallocator, "remote_node" => remote_node}) 
            response_body = send_request("POST", url)
 
-           return "?"
+           return response_body
         end
 
         # Migrates all primary instances of a node
@@ -343,7 +493,7 @@ module GanetiClient
             url = get_url("nodes/#{name}/migrate", {"live" => live})
             response_body = send_request("POST", url)
 
-            return "?"
+            return response_body
         end
 
         # Get the node role
@@ -515,9 +665,9 @@ module GanetiClient
         private
 
         def authenticate(username, password)
-            basic = Base64.b64encode("#{username}:#{password}") 
+            basic = Base64.encode64("#{username}:#{password}").strip
             headers = {'Authorization' => "Basic #{basic}"}
-        
+      
             return headers         
         end
     
@@ -528,20 +678,33 @@ module GanetiClient
                 params.each do |key, value|
                     if value.kind_of?(Array)
                         value.each do |svalue|
-                            param_string += "#{key}=#{svalue}"
+                            param_string += "#{key}=#{svalue}&"
                         end
                     else
                         param_string += "#{key}=#{value}&"
                     end
                 end
             end
-            return (self.version)? "/#{self.version}/#{path}?#{param_string}" : "/#{path}?#{param_string}"
+
+            url =  (self.version)? "/#{self.version}/#{path}?#{param_string}" : "/#{path}?#{param_string}"
+  
+            return url.chop
         end
 
         def send_request(method, url, body = nil)
-            response = self.conn.send_request(method, url, body)
+            uri = URI.parse(host)
+
+            http = Net::HTTP.new(uri.host, uri.port)
+            http.use_ssl = (uri.scheme == "http")? false : true
+
+            headers = {}
+            headers = authenticate(self.username, self.password) if method != 'GET'
+
+            response = http.send_request(method, url, body, headers)
+
+
+            puts "Response #{response.code} #{response.message}: #{response.body}" if self.show_response
 
-            puts "Response #{response.code} #{response.message}: #{response.body}" if self.show_reponse
             return response.body.strip
         end
 

data/lib/ganeti_client.rb

@@ -1,3 +1,27 @@
+#--
+# Copyright (c) 2010 Michaël Rigart
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+
 require 'net/http'
 require 'net/https'
 require 'uri'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ganeti_client
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - "Micha\xC3\xABl Rigart"