openstack 1.0.6 → 1.0.7

data/README.rdoc

@@ -2,13 +2,15 @@
 
 == Description
 
-Ruby Openstack Compute and Object-Store bindings for the v1.0 OSAPI.
+Ruby Openstack Compute, Object-Store and Block Storage bindings for the OpenStack API.
+
+http://api.openstack.org/api-reference.html
 
 Currently supports both v1.0 and v2.0 (keystone) auth.
 
 Use OpenStack::Connection.create to get a handle to an OpenStack service - set the :service_type parameter to either 'compute' or 'object-store' (defaults to 'compute'). If the requested service is not deployed the gem will throw a OpenStack::Exception::NotImplemented (501) - e.g. :service_type is 'object-store' but swift service isn't deployed.
 
-The OpenStack::Connection.create class method is a factory constructor which will return the appropriate Connection object, depending on the ':service_type' parameter passed with the options hash: set to either 'compute' or 'object-store' (defaults to 'compute') - see below for examples.
+The OpenStack::Connection.create class method is a factory constructor which will return the appropriate Connection object, depending on the ':service_type' parameter passed with the options hash: set to either 'compute', 'volume', or  'object-store' (defaults to 'compute') - see below for examples.
 
 Other parameters for the create method:
 
@@ -179,6 +181,53 @@ See the class definitions for documentation on specific methods and operations.
   >>  os.delete_security_group(9571)
   => true
 
+  #Attach a volume to a server - params in order are: server_id, volume_id, attachment_point
+
+  >> os.attach_volume(704289, 90805, "/dev/sde")
+  => true
+
+  #List attachments for a server:
+
+  >> os.list_attachments 704289
+  => {:volumeAttachments=>[{:device=>"/dev/sde", :serverId=>704289, :id=>90805, :volumeId=>90805}]}
+
+  #Detach volume from server - params in order are server_id and attachment_id
+  >> os.detach_volume(704289, 90805)
+  => true
+
+== Examples for Volumes:
+
+  #NOTE - attach/detach operations are implemented for the compute service as the OS API defines these operations as extensions to Openstack Compute.
+
+  vs = OpenStack::Connection.create({:username => "username", :api_key=>"pass", :auth_url => "https://region-a.geo-1.identity.hpcloudsvc.com:35357/v2.0/", :authtenant=>"username-default-tenant", :service_type=>"volume"})
+
+  # Create a volume: - MUST specify display_name and size parameters... optional params are {:display_description, :metadata=>{:key=>val, ...}, :availability_zone, :volume_type }
+
+  >> volume = vs.create_volume({:display_name=>"marios volume", :size=>1, :display_description=>"some new volume bla"})
+  => #<OpenStack::Volume::Volume:0x8a3c534 @id=90805, @display_name="marios volume", @display_description="some new volume bla", @size=1, @volume_type=nil, @metadata={}, @availability_zone="nova", @snapshot_id="", @attachments=[{}], @created_at="2012-11-15 13:51:23">
+
+  >> volume.size
+  => 1
+
+  >> volume.attachments
+  => [{}]
+
+  # List volumes:
+
+  >> vs.list_volumes                    #aliased as just 'volumes' ... vs.volumes
+  => [#<OpenStack::Volume::Volume:0x8aad2e8 @id=90625, @display_name="marios volume", @display_description="attach test volume", @size=1, @volume_type=nil, @metadata={}, @availability_zone="nova", @snapshot_id="", @attachments=[{}], @created_at="2012-11-15 09:54:58">, #<OpenStack::Volume::Volume:0x8aad144 @id=90805, @display_name="marios volume", @display_description="some new volume bla", @size=1, @volume_type=nil, @metadata={}, @availability_zone="nova", @snapshot_id="", @attachments=[{}], @created_at="2012-11-15 13:51:23">]
+
+  # Get a particular volume - must specify ID:
+
+  >> vs.get_volume(90625)                #aliased as 'volume'
+  => #<OpenStack::Volume::Volume:0x8abd4a4 @id=90625, @display_name="marios volume", @display_description="attach test volume", @size=1, @volume_type=nil, @metadata={}, @availability_zone="nova", @snapshot_id="", @attachments=[{}], @created_at="2012-11-15 09:54:58">
+
+  # Delete a volume:
+
+  >> vs.delete_volume(90805)
+  => true
+
+
 == Examples for Object-Store:
 
 

data/VERSION

@@ -1 +1 @@
-1.0.6
+1.0.7

data/lib/openstack.rb

@@ -42,6 +42,10 @@ module OpenStack
   require 'openstack/swift/connection'
   require 'openstack/swift/container'
   require 'openstack/swift/storage_object'
+  require 'openstack/volume/connection'
+  require 'openstack/volume/volume'
+  require 'openstack/volume/snapshot'
+
 
   # Constants that set limits on server creation
   MAX_PERSONALITY_ITEMS = 5

data/lib/openstack/compute/connection.rb

@@ -387,6 +387,26 @@ module Compute
       response = @connection.req("DELETE", "/os-security-group-rules/#{id}")
       true
     end
+
+#VOLUMES - attach detach
+    def attach_volume(server_id, volume_id, device_id)
+      raise OpenStack::Exception::NotImplemented.new("os-volumes not implemented by #{@connection.http.keys.first}", 501, "NOT IMPLEMENTED") unless api_extensions[:"os-volumes"]
+      data = JSON.generate(:volumeAttachment => {"volumeId" => volume_id, "device"=> device_id})
+      response = @connection.req("POST", "/servers/#{server_id}/os-volume_attachments", {:data=>data})
+      true
+    end
+
+    def list_attachments(server_id)
+      raise OpenStack::Exception::NotImplemented.new("os-volumes not implemented by #{@connection.http.keys.first}", 501, "NOT IMPLEMENTED") unless api_extensions[:"os-volumes"]
+      response = @connection.req("GET", "/servers/#{server_id}/os-volume_attachments")
+      OpenStack.symbolize_keys(JSON.parse(response.body))
+    end
+
+    def detach_volume(server_id, attachment_id)
+      raise OpenStack::Exception::NotImplemented.new("os-volumes not implemented by #{@connection.http.keys.first}", 501, "NOT IMPLEMENTED") unless api_extensions[:"os-volumes"]
+      response = @connection.req("DELETE", "/servers/#{server_id}/os-volume_attachments/#{attachment_id}")
+      true
+    end
   end
 end
 end

data/lib/openstack/connection.rb

@@ -63,6 +63,8 @@ class Connection
           OpenStack::Compute::Connection.new(connection)
         when "object-store"
           OpenStack::Swift::Connection.new(connection)
+        when "volume"
+          OpenStack::Volume::Connection.new(connection)
         else
           raise Exception::InvalidArgument, "Invalid :service_type parameter: #{@service_type}"
       end
@@ -242,9 +244,9 @@ class Authentication
 end
 
  private
-
 class AuthV20
   attr_reader :uri
+  attr_reader :version
   def initialize(connection)
     begin
       server = Net::HTTP::Proxy(connection.proxy_host, connection.proxy_port).new(connection.auth_host, connection.auth_port)
@@ -292,6 +294,14 @@ class AuthV20
           if @uri == ""
             raise OpenStack::Exception::Authentication, "No API endpoint for region #{connection.region}"
           else
+            if @version #already got one version of endpoints
+              current_version = get_version_from_response(service)
+              if @version.to_f > current_version.to_f
+                next
+              end
+            end
+            #grab version to check next time round for multi-version deployments
+            @version = get_version_from_response(service)
             connection.service_host = @uri.host
             connection.service_path = @uri.path
             connection.service_port = @uri.port
@@ -306,6 +316,17 @@ class AuthV20
     end
     server.finish if server.started?
   end
+
+  def get_version_from_response(service)
+    service["endpoints"].first["versionId"] || parse_version_from_endpoint(service["endpoints"].first["publicURL"])
+  end
+
+  #IN  --> https://az-2.region-a.geo-1.compute.hpcloudsvc.com/v1.1/46871569847393
+  #OUT --> "1.1"
+  def parse_version_from_endpoint(endpoint)
+    endpoint.match(/\/v(\d).(\d)/).to_s.sub("/v", "")
+  end
+
 end
 
 class AuthV10

data/lib/openstack/volume/connection.rb

@@ -0,0 +1,90 @@
+module OpenStack
+module Volume
+
+  class Connection
+
+    attr_accessor   :connection
+    attr_reader     :volumes_native
+
+    def initialize(connection)
+      @connection = connection
+      OpenStack::Authentication.init(@connection)
+      @volumes_native, @volume_path = check_if_native
+    end
+
+    # Returns true if the authentication was successful and returns false otherwise.
+    #
+    #   cs.authok?
+    #   => true
+    def authok?
+      @connection.authok
+    end
+
+    #require params:  {:display_name, :size}
+    #optional params: {:display_description, :metadata=>{:key=>val, ...}, :availability_zone, :volume_type }
+    #returns OpenStack::Volume::Volume object
+    def create_volume(options)
+      raise OpenStack::Exception::MissingArgument, ":display_name and :size must be specified to create a volume" unless (options[:display_name] && options[:size])
+      data = JSON.generate(:volume => options)
+      response = @connection.csreq("POST",@connection.service_host,"#{@connection.service_path}/#{@volume_path}",@connection.service_port,@connection.service_scheme,{'content-type' => 'application/json'},data)
+      volume_info = JSON.parse(response.body)["volume"]
+      volume = OpenStack::Volume::Volume.new(volume_info)
+    end
+
+    #no options documented in API at Nov 2012
+    #(e.g. like limit/marker as used in Nova for servers)
+    def list_volumes
+      response = @connection.req("GET", "/#{@volume_path}")
+      volumes_hash = JSON.parse(response.body)["volumes"]
+      volumes_hash.inject([]){|res, current| res << OpenStack::Volume::Volume.new(current); res}
+    end
+    alias :volumes :list_volumes
+
+
+    def get_volume(vol_id)
+      response = @connection.req("GET", "/#{@volume_path}/#{vol_id}")
+      volume_hash = JSON.parse(response.body)["volume"]
+      OpenStack::Volume::Volume.new(volume_hash)
+    end
+    alias :volume :get_volume
+
+    def delete_volume(vol_id)
+      response = @connection.req("DELETE", "/#{@volume_path}/#{vol_id}")
+      true
+    end
+
+    #TODO SNAPSHOTS
+
+    private
+
+    #fudge... not clear if volumes support is available as 'native' volume API or
+    #as the os-volumes extension. Need to probe to find out (for now)
+    #see https://lists.launchpad.net/openstack/msg16601.html
+    def check_if_native
+      native = extension = false
+      #check if 'native' volume API present:
+      begin
+        response = @connection.req("GET", "/volumes")
+        native = true if response.code.match(/^20.$/)
+        return true, "volumes"
+      rescue OpenStack::Exception::ItemNotFound => not_found
+        native = false
+      end
+      #check if available as extension:
+      begin
+        response = @connection.req("GET", "/os-volumes")
+        extension = true if response.code.match(/^20.$/)
+        return false, "os-volumes"
+      rescue OpenStack::Exception::ItemNotFound => not_found
+        extension = false
+      end
+      raise OpenStack::Exception::NotImplemented.new("No Volumes support for this provider", 501, "No Volumes Support") unless (native || extension)
+    end
+
+
+
+
+  end
+
+end
+end

data/lib/openstack/volume/volume.rb

@@ -0,0 +1,31 @@
+module OpenStack
+  module Volume
+    class Volume
+
+    attr_reader :id
+    attr_reader :display_name
+    attr_reader :display_description
+    attr_reader :size
+    attr_reader :volume_type
+    attr_reader :metadata
+    attr_reader :availability_zone
+    attr_reader :snapshot_id
+    attr_reader :attachments
+    attr_reader :created_at
+
+    def initialize(volume_info)
+      @id  = volume_info["id"]
+      @display_name  = volume_info["display_name"] || volume_info["displayName"]
+      @display_description  = volume_info["display_description"] || volume_info["displayDescription"]
+      @size  = volume_info["size"]
+      @volume_type  = volume_info["volume_type"] || volume_info["volumeType"]
+      @metadata  = volume_info["metadata"]
+      @availability_zone  = volume_info["availability_zone"] || volume_info["availabilityZone"]
+      @snapshot_id  = volume_info["snapshot_id"] || volume_info["snapshotId"]
+      @attachments  = volume_info["attachments"]
+      @created_at  = volume_info["created_at"] || volume_info["createdAt"]
+    end
+
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openstack
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-13 00:00:00.000000000 Z
+date: 2012-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha
@@ -84,6 +84,9 @@ files:
 - lib/openstack/swift/connection.rb
 - lib/openstack/swift/container.rb
 - lib/openstack/swift/storage_object.rb
+- lib/openstack/volume/connection.rb
+- lib/openstack/volume/snapshot.rb
+- lib/openstack/volume/volume.rb
 - test/authentication_test.rb
 - test/connection_test.rb
 - test/exception_test.rb