rubineti 1.0.2

data/.rvmrc

@@ -0,0 +1 @@
+rvm ruby-1.9.2-p0@rubineti

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+
+gem "yajl-ruby", "~> 0.7.8"
+gem "net-http-persistent", "~> 1.4.1"
+
+group :development do
+  gem "rake"
+  gem "jeweler", "~> 1.5.1"
+  gem "vcr", "~> 1.3.3"
+  gem "webmock", "~> 1.6.1"
+  gem "minitest", "~> 2.0.0"
+  gem "mocha", "~> 0.9.10"
+end

data/Gemfile.lock

@@ -0,0 +1,33 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.2)
+    crack (0.1.8)
+    git (1.2.5)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    minitest (2.0.0)
+    mocha (0.9.10)
+      rake
+    net-http-persistent (1.4.1)
+    rake (0.8.7)
+    vcr (1.3.3)
+    webmock (1.6.1)
+      addressable (>= 2.2.2)
+      crack (>= 0.1.7)
+    yajl-ruby (0.7.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler (~> 1.5.1)
+  minitest (~> 2.0.0)
+  mocha (~> 0.9.10)
+  net-http-persistent (~> 1.4.1)
+  rake
+  vcr (~> 1.3.3)
+  webmock (~> 1.6.1)
+  yajl-ruby (~> 0.7.8)

data/LICENSE

@@ -0,0 +1,4 @@
+"THE BEER-WARE LICENSE" (Revision 42):
+<john@dewey.ws> wrote this file. As long as you retain this notice you
+can do whatever you want with this stuff. If we meet some day, and you think
+this stuff is worth it, you can buy me a beer in return John-B Dewey Jr.

data/README.md

@@ -0,0 +1,44 @@
+# rubineti
+
+[Ruby](http://www.ruby-lang.org/) bindings to [Ganeti's](http://code.google.com/p/ganeti/) Version 2 Remote API.  
+
+## Usage
+
+### Bundler
+
+    gem "rubineti"
+
+### Examples
+
+Initialize a connection
+
+    @connection = Rubineti::Compute.new :host => "ganeti.primary", :credentials => "fake:credentials"
+
+View all jobs
+
+    @connection.jobs_list
+
+Handling query params
+
+    @connection.instance_info "instance_name", :query => "bulk=1"
+
+The responses are objectified [(by Yajl)](https://github.com/lloyd/yajl), and returned unmodified.
+
+## Testing
+
+Tests can run offline thanks to [VCR](https://github.com/myronmarston/vcr).
+
+    $ bundle exec rake
+
+## Documents
+
+* [Ganeti's remote API](http://docs.ganeti.org/ganeti/2.1/html/rapi.html)
+
+## Contributions
+
+I have implemented the end-points immediately needed.  Feel free to send me pull requests, if you
+wish to help out.
+
+## Credits
+
+Wesley Beary's [fog](https://github.com/geemus/fog), for which I referenced.

data/Rakefile

@@ -0,0 +1,22 @@
+begin
+  require "jeweler"
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rubineti"
+    gem.summary = %Q{Ruby bindings to Ganeti's v2 Remote API.}
+    gem.email = "john@dewey.ws"
+    gem.homepage = "http://github.com/retr0h/rubineti"
+    gem.authors = ["retr0h"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require "rake/testtask"
+Rake::TestTask.new(:test) do |test|
+  test.libs   << "./lib" << "./test"
+  test.pattern = "test/**/test_*.rb"
+  test.verbose = true
+end
+
+task :default => :test

data/VERSION

@@ -0,0 +1 @@
+1.0.2

data/lib/ganeti.rb

@@ -0,0 +1,6 @@
+module Ganeti
+  ##
+  # Remote API Version.
+
+  Version = 2
+end

data/lib/rubineti/compute/cluster.rb

@@ -0,0 +1,74 @@
+module Rubineti
+  module Cluster
+    ##
+    # Returns a list of features supported by the RAPI server.
+
+    def cluster_features
+      warn "WARNING: Cluster#cluster_features not implemented."
+      # get "/#{Ganeti::Version}/features"
+    end
+
+    ##
+    # Returns a list of cluster information.
+
+    def cluster_info
+      get "/#{Ganeti::Version}/info"
+    end
+
+    ##
+    # Redistribute configuration to all nodes.
+    # Returns a job_id.
+
+    def cluster_redistribute_config
+      put "/#{Ganeti::Version}/redistribute-config"
+    end
+
+    ##
+    # Adds a set of tags.
+    # Returns a job_id.
+    #
+    # If the optional dry-run parameter (?dry-run=1) is provided,
+    # the job will not be actually executed, only the pre-execution
+    # checks will be done.
+
+    def cluster_tags_create params = {}
+      warn "WARNING: Cluster#cluster_tags_create not implemented."
+      # put "/#{Ganeti::Version}/tags", params
+    end
+
+    ##
+    # Delete tags.
+    # Returns a job_id.
+    #
+    # If the optional dry-run parameter (?dry-run=1) is provided,
+    # the job will not be actually executed, only the pre-execution
+    # checks will be done.
+
+    def cluster_tags_delete params = {}
+      warn "WARNING: Cluster#cluster_tags_delete not implemented."
+      # delete "/#{Ganeti::Version}/tags", params
+    end
+
+    ##
+    # Returns the cluster tags.
+
+    def cluster_tags_list
+      warn "WARNING: Cluster#cluster_tags_list not implemented."
+      # get "/#{Ganeti::Version}/tags"
+    end
+
+    ##
+    # Returns the cluster API version.
+
+    def cluster_version
+      get "/version"
+    end
+
+    ##
+    # Return a list of all OSes.
+
+    def cluster_os_list
+      get "/#{Ganeti::Version}/os"
+    end
+  end
+end

data/lib/rubineti/compute/instances.rb

@@ -0,0 +1,245 @@
+module Rubineti
+  module Instances
+    ##
+    # Activate disks on an instance.
+    # Returns a job id.
+    #
+    # Takes the bool parameter ignore_size.
+    # (useful for forcing activation when recorded size is wrong).
+
+    def instance_activate_disks instance_name, params = {}
+      warn "WARNING: Instances#instance_activate_disks not implemented."
+      # put "/#{Ganeti::Version}/instances/#{instance_name}/activate-disks", params
+    end
+
+    ##
+    # Creates an instance.
+    # Returns a job id.
+    #
+    # Body parameters:
+    #   - http://docs.ganeti.org/ganeti/#{Ganeti::Version}.2/html/rapi.html#instances
+    #
+    # If the optional dry-run parameter (?dry-run=1) is provided,
+    # the job will not be actually executed, only the pre-execution
+    # checks will be done.
+
+    def instance_create params = {}
+      post "/#{Ganeti::Version}/instances", params
+    end
+
+    ##
+    # Deactivate disks on an instance.
+    # Returns a job id.
+
+    def instance_deactivate_disks instance_name
+      warn "WARNING: Instances#instance_deactivate_disks not implemented."
+      # put "/#{Ganeti::Version}/instances/#{instance_name}/deactivate-disks"
+    end
+
+    ##
+    # Deletes an instance.
+    # Returns a job id.
+    #
+    # If the optional dry-run parameter (?dry-run=1) is provided,
+    # the job will not be actually executed, only the pre-execution
+    # checks will be done.
+
+    def instance_delete instance_name, params = {}
+      delete "/#{Ganeti::Version}/instances/#{instance_name}", params
+    end
+
+    ##
+    # Exports an instance.
+    # Returns a job id.
+    #
+    # Body parameters:
+    #   - http://docs.ganeti.org/ganeti/#{Ganeti::Version}.2/html/rapi.html#instances-instance-name-export
+
+    def instance_export instance_name, params = {}
+      warn "WARNING: Instances#instance_export not implemented."
+      # put "/#{Ganeti::Version}/instances/#{instance_name}/export", params
+    end
+
+    ##
+    # Requests detailed information about the 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.
+
+    def instance_info instance_name, params = {}
+      get "/#{Ganeti::Version}/instances/#{instance_name}/info", params
+    end
+
+    ##
+    # Returns information about an instance, similar to
+    # the bulk output from +#instances_list+.
+
+    def instance_list instance_name
+      get "/#{Ganeti::Version}/instances/#{instance_name}"
+    end
+
+    ##
+    # Migrates an instance.
+    # Returns a job id.
+    #
+    # Body parameters:
+    #   - http://docs.ganeti.org/ganeti/#{Ganeti::Version}.2/html/rapi.html#instances-instance-name-migrate
+
+    def instance_migrate instance_name, params = {}
+      warn "WARNING: Instances#instance_migrate not implemented."
+      # put "/#{Ganeti::Version}/instances/#{instance_name}/migrate", params
+    end
+
+    ##
+    # Modifies an instance.
+    # Returns a job id.
+    #
+    # Body parameters:
+    #   - http://docs.ganeti.org/ganeti/#{Ganeti::Version}.2/html/rapi.html#instances-instance-name-modify
+
+    def instance_modify instance_name, params = {}
+      warn "WARNING: Instances#instance_modify not implemented."
+      # put "/#{Ganeti::Version}/instances/#{instance_name}/modify", params
+    end
+
+    ##
+    # Prepares an export of an instance.
+    # Returns a job id.
+    #
+    # Takes one parameter, mode, for the export mode.
+
+    def instance_prepare_export instance_name, params = {}
+      warn "WARNING: Instances#instance_prepare_export not implemented."
+      # put "/#{Ganeti::Version}/instances/#{instance_name}/prepare-disks", params
+    end
+
+    ##
+    # Reboots the instance.
+    # Returns a job id.
+    #
+    # The URI takes optional type=soft|hard|full and ignore_secondaries=0|1 parameters.
+    #   - soft is just a normal reboot, without terminating the hypervisor.
+    #   - hard means full shutdown (including terminating the hypervisor process)
+    #     and startup again.
+    #   - full is like hard but also recreates the configuration from ground up
+    #     as if you would have done a gnt-instance shutdown and gnt-instance start on it.
+    #   - ignore_secondaries parameter (?ignore_secondaries=1), will start the
+    #     instance even if secondary disks are failing.
+    #
+    # If the optional dry-run parameter (?dry-run=1) is provided,
+    # the job will not be actually executed, only the pre-execution
+    # checks will be done.
+
+    def instance_reboot instance_name, params = {}
+      post "/#{Ganeti::Version}/instances/#{instance_name}/reboot", params
+    end
+
+    ##
+    # Reinstalls the instance's operating system.
+    # Returns a job id.
+    #
+    # Takes the parameters os (OS template name) and nostartup (bool).
+
+    def instance_reinstall instance_name, params = {}
+      post "/#{Ganeti::Version}/instances/#{instance_name}/reinstall", params
+    end
+
+    ##
+    # Renames an instance.
+    # Returns a job id.
+    #
+    # Body parameters:
+    #   - http://docs.ganeti.org/ganeti/#{Ganeti::Version}.2/html/rapi.html#instances-instance-name-rename
+
+    def instance_rename instance_name, params = {}
+      $stderr.print "WARNING: Instances#instance_rename not implemented."
+      # put "/#{Ganeti::Version}/instances/#{instance_name}/rename", params
+    end
+
+    ##
+    # Replaces disks on an instance.
+    # Returns a job id.
+    #
+    # Takes the mandatory  parameters mode:
+    #  - (one of replace_on_primary, replace_on_secondary, replace_new_secondary or replace_auto),
+    #  - disks (comma separated list of disk indexes)
+    #  - remote_node and iallocator
+    #
+    # Either remote_node or iallocator needs to be defined when using mode=replace_new_secondary.
+    # replace_auto tries to determine the broken disk(s) on its own and replacing it.
+
+    def instance_replace_disks instance_name, params = {}
+      warn "WARNING: Instances#instance_replace_disks not implemented."
+      # post "/#{Ganeti::Version}/instances/#{instance_name}/replace-disks", params
+    end
+
+    ##
+    # Shutdown an instance.
+    # Returns a job id.
+    #
+    # If the optional dry-run parameter (?dry-run=1) is provided,
+    # the job will not be actually executed, only the pre-execution
+    # checks will be done.
+
+    def instance_shutdown instance_name, params = {}
+      put "/#{Ganeti::Version}/instances/#{instance_name}/shutdown", params
+    end
+
+    ##
+    # Returns a list of all available instances.
+    #
+    # If the optional bulk parameter (?bulk=1) is provided,
+    # the output contains detailed information about instances as a list.
+
+    def instances_list params = {}
+      get "/#{Ganeti::Version}/instances", params
+    end
+
+    ##
+    # Startup an instance.
+    # Returns a job id.
+    #
+    # If the optional dry-run parameter (?dry-run=1) is provided,
+    # the job will not be actually executed, only the pre-execution
+    # checks will be done.
+
+    def instance_startup instance_name, params = {}
+      put "/#{Ganeti::Version}/instances/#{instance_name}/startup", params
+    end
+
+    ##
+    # Add a set of tags.
+    # Returns a job id.
+    #
+    # If the optional dry-run parameter (?dry-run=1) is provided,
+    # the job will not be actually executed, only the pre-execution
+    # checks will be done.
+
+    def instance_tag_create instance_name, params = {}
+      warn "WARNING: Instances#instance_tag_create not implemented."
+      # put "/#{Ganeti::Version}/instances/#{instance_name}/tags", params
+    end
+
+    ##
+    # Delete a tag.
+    # Returns a job id.
+    #
+    # If the optional dry-run parameter (?dry-run=1) is provided,
+    # the job will not be actually executed, only the pre-execution
+    # checks will be done.
+
+    def instance_tag_delete instance_name, params = {}
+      warn "WARNING: Instances#instance_tag_delete not implemented."
+      # delete "/#{Ganeti::Version}/instances/#{instance_name}/tags", params
+    end
+
+    ##
+    # Return a list of tags.
+
+    def instance_tag_list instance_name, params = {}
+      warn "WARNING: Instances#instance_tag_list not implemented."
+      # get "/#{Ganeti::Version}/instances/#{instance_name}/tags", params
+    end
+  end
+end

data/lib/rubineti/compute/jobs.rb

@@ -0,0 +1,42 @@
+module Rubineti
+  module Jobs
+    ##
+    # Returns an Array of all jobs.
+
+    def jobs_list
+      get "/#{Ganeti::Version}/jobs"
+    end
+
+    ##
+    # Returns a jobs status.
+    #
+    # +job_id+: A String of the 'job id'.
+
+    def job_list job_id
+      get "/#{Ganeti::Version}/jobs/#{job_id}"
+    end
+
+    ##
+    # Cancel a not-yet-started job.
+    #
+    # +job_id+: A String of the 'job id'.
+
+    def job_delete job_id
+      warn "WARNING: Jobs#job_delete not implemented."
+      # delete "/#{Ganeti::Version}/jobs/#{job_id}/delete"
+    end
+
+    ##
+    # Waits for changes on a job.
+    #
+    # +job_id+: A String of the 'job id'.
+    #
+    # Body parameters:
+    #   - http://docs.ganeti.org/ganeti/#{Ganeti::Version}.1/html/rapi.html#jobs-job-id-wait
+
+    def job_wait job_id, params = {}
+      warn "WARNING: Jobs#job_wait not implemented."
+      # get "/#{Ganeti::Version}/jobs/#{job_id}/wait", params
+    end
+  end
+end

data/lib/rubineti/compute/node.rb

@@ -0,0 +1,140 @@
+module Rubineti
+  module Node
+
+    ##
+    # Evacuates all secondary instances off a node.
+    #
+    # To evacuate a node, either one of the iallocator or remote_node parameters must be passed:
+    #   - evacuate?iallocator=[iallocator]
+    #   - evacuate?remote_node=[nodeX.example.com]
+    # See: http://docs.ganeti.org/ganeti/2.2/html/rapi.html#nodes-node-name-evacuate
+    #
+    # If the optional dry-run parameter (?dry-run=1) is provided,
+    # the job will not be actually executed, only the pre-execution
+    # checks will be done.
+
+    def node_evacuate node_name, params = {}
+      warn "WARNING: Node#node_evacuate not implemented."
+      # post "/2/nodes/#{node_name}/evacuate", params
+    end
+
+    ##
+    # Returns information about a node.
+
+    def node_list node_name
+      get "/2/nodes/#{node_name}"
+    end
+
+    ##
+    # Migrates all primary instances from a node.
+    #
+    # If no mode is explicitly specified, each instances’ hypervisor
+    # default migration mode will be used. Query parameters:
+    #   - live (bool): If set, use live migration if available.
+    #   - mode (string): Sets migration mode, live for live migration
+    #     and non-live for non-live migration. Supported by Ganeti 2.2 and above.
+
+    def node_migrate node_name, params = {}
+      warn "WARNING: Node#node_migrate not implemented."
+      # post "/2/nodes/#{node_name}/migrate", params
+    end
+
+    ##
+    # Change the node role.
+    # Returns a job id.
+    #
+    # It supports the bool force argument.
+
+    def node_role_create node_name
+      warn "WARNING: Node#node_role_create not implemented."
+      # TODO: API Docs do not describe it's usage well.
+      # put "/2/nodes/#{node_name}/role"
+    end
+
+    ##
+    # Returns the current node role.
+
+    def node_role_list node_name
+      get "/2/nodes/#{node_name}/role"
+    end
+
+    ##
+    # Returns a list of all nodes.
+    #
+    # If the optional bulk parameter (?bulk=1) is provided,
+    # the output contains detailed information about instances as a list.
+
+    def nodes_list params = {}
+      get "/2/nodes", params
+    end
+
+    ##
+    # Requests a list of storage units on a node.
+    # Returns a job id.
+    #
+    # Requires the parameters storage_type (one of file, lvm-pv or lvm-vg) and output_fields.
+
+    def node_storage_list node_name, params = {}
+      warn "WARNING: Node#node_storage_list not implemented."
+      # get "/2/nodes/#{node_name}/storage", params
+    end
+
+    ##
+    # Modifies storage units on the node.
+    # Returns a job id.
+    #
+    # Requires the parameters storage_type (one of file, lvm-pv or lvm-vg) and name (name of the storage unit).
+    # Parameters can be passed additionally. Currently only allocatable (bool) is supported.
+
+    def node_storage_modify node_name, params = {}
+      warn "WARNING: Node#node_storage_modify not implemented."
+      # put "/2/nodes/#{node_name}/storage/modify", params
+    end
+
+    ##
+    # Repairs a storage unit on the node.
+    # Returns a job id.
+    #
+    # Requires the parameters storage_type (currently only lvm-vg can be repaired) and
+    # name (name of the storage unit).
+
+    def node_storage_repair node_name, params = {}
+      warn "WARNING: Node#node_storage_repair not implemented."
+      # put "/2/nodes/#{node_name}/repair", params
+    end
+
+    ##
+    # Add a set of tags.
+    # Returns a job id.
+    #
+    # If the optional dry-run parameter (?dry-run=1) is provided,
+    # the job will not be actually executed, only the pre-execution
+    # checks will be done.
+
+    def node_tags_create node_name, params = {}
+      warn "WARNING: Node#node_tags_create not implemented."
+      # put "/2/nodes/#{node_name}/tags", params
+    end
+
+    ##
+    # Deletes tags.
+    # Returns a job id.
+    #
+    # If the optional dry-run parameter (?dry-run=1) is provided,
+    # the job will not be actually executed, only the pre-execution
+    # checks will be done.
+
+    def node_tags_delete node_name, params = {}
+      warn "WARNING: Node#node_tags_delete not implemented."
+      # delete "/2/nodes/#{node_name}/tags", params
+    end
+
+    ##
+    # Return a list of tags.
+
+    def node_tags_list node_name
+      warn "WARNING: Node#node_tags_list not implemented."
+      # get "/2/nodes/#{node_name}/tags"
+    end
+  end
+end