solidfire_api 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 197ba47760fa5e1508dde1f6cce7cd7c50db5250
-  data.tar.gz: 8568fef138ef8ed357416bcbe2f4ce575336cc72
+  metadata.gz: 3bb1882b6f1d24c2b4a1be22c65c247dec99c559
+  data.tar.gz: cb8172512eccefc3eeaa6918eff4543c7190048b
 SHA512:
-  metadata.gz: bf73a214def5e614ba5e69352d9fbd8d0a3320131c3f51a832f426d0554272b7ebda99810f6c375f12cfdf3c31c74e541300ce12e2608a9f4c5f4b8d6c63ab97
-  data.tar.gz: 948996a996ca3e1e9e72bda4fceeb2dac98d6dceb6ae8e68ecd91910e1b9f9f3c3034459ba3325acdf38b040d24d9ab963958452d6686ae95b26ac6f1d018b31
+  metadata.gz: 9ce4159b95897f71ec240dc96d2b983a5fd4408c958e5748ab04f0329eb28bfb8bf491c287d964c7c295511c835ee5102339e8b79e80809ffc68bbd114921269
+  data.tar.gz: 9943e27ef488a441eca7cd1b784d2a4ce837131c3e1fd13f20100e20cad53274140b498f1d04d005ac2cb4a332e54b8c350026f3c27dbb1797a4b0e624b57337

data/README.md

@@ -1,6 +1,10 @@
 # SolidfireApi
 
-Ruby Gem to connect on Solidfire storage Array API to collect stats. Currently support Simple Authentication and very basic functionalities.
+Ruby Gem to connect on [Solidfire](http://www.solidfire.com/) storage Array API to collect stats. Currently support Simple Authentication and very basic functionalities.
+
+Currently supporting volumes, cluster and disks listing and stats API call's to collect performance metrics for monitoring usage. Nothing for managing cluster yet.
+
+Creation of VolumeAccessGroup, map volumes and iSCSI initiator. 
 
 Use gem: RestClient to interract with Solidfire API. 
 
@@ -21,6 +25,8 @@ Install it:
 
 ## Usage
 
+### Get some cluster informations
+
 ```ruby
   require 'solidfire_api'
   my_sf = SolidfireApi::Connection.new({
@@ -37,8 +43,25 @@ Install it:
   
 ```
 
-Currently supporting volumes and cluster listing and stats API call's to collect performance metrics for monitoring usage. Nothing for managing cluster yet.
 
+### Map Volume to a Volume Access Group
+
+If you don't want to use CHAP authentication for iSCSI LUN access from initiator, you have to attach Volume to Volume Access Group that include iSCSI initiators.
+
+Administrator privileges required.
+
+```ruby
+  require 'solidfire_api'
+  my_sf = SolidfireApi::Connection.new({
+    :mvip => "192.168.0.1",
+    :username => "admin",
+    :password =>  "admin_password"
+  })
+  
+  my_sf.vag_add_volume("volumename", "group_name")
+   => {}
+
+```
 
 ## Contributing
 
@@ -47,3 +70,7 @@ Currently supporting volumes and cluster listing and stats API call's to collect
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Todo
+
+* Everything else

data/lib/solidfire_api/cluster.rb

@@ -66,8 +66,37 @@ module Cluster
       :params => {
       }
     }
-    answer = query_sf(api_call)
-    return answer["clusterCapacity"]
+    answer = query_sf(api_call)["clusterCapacity"]
+    
+    # thinProvisioningFactor metric, calculated based on document instructions.
+    # if condition to avoid divide by 0.
+    if answer["nonZeroBlocks"] == 0
+      answer["thinProvisioningFactor"] = 0
+    else
+      answer["thinProvisioningFactor"] = (answer["nonZeroBlocks"] + answer["zeroBlocks"]) / answer["nonZeroBlocks"]
+    end
+    
+    # deDuplicationFactor metric, calculated based on document instructions.
+    # if condition to avoid divide by 0.
+    if answer["uniqueBlocks"] == 0
+      answer["deDuplicationFactor"] = 0
+    else
+      answer["deDuplicationFactor"] = answer["nonZeroBlocks"] / answer["uniqueBlocks"]
+    end
+    
+    # compressionFactor metric, calculated based on document instructions.
+    # if condition to avoid divide by 0.
+    if answer["uniqueBlocksUsedSpace"] == 0
+      answer["compressionFactor"] = 0
+    else
+      answer["compressionFactor"] = (answer["uniqueBlocks"] * 4096) / answer["uniqueBlocksUsedSpace"]
+    end
+    
+    # efficiencyFactor metric, calculated based on document instructions.
+    # efficiencyFactor = thinProvisioningFactor * deDuplicationFactor * compressionFactor
+    answer["efficiencyFactor"] = answer["thinProvisioningFactor"] * answer["deDuplicationFactor"] * answer["compressionFactor"]
+    
+    return answer
   end 
   
 

data/lib/solidfire_api/connection.rb

@@ -2,6 +2,7 @@
 require 'solidfire_api/volume'
 require 'solidfire_api/node'
 require 'solidfire_api/cluster'
+require 'solidfire_api/volume_access_group'
 
 module SolidfireApi
   
@@ -19,6 +20,7 @@ module SolidfireApi
     include Cluster
     include Volume
     include Node
+    include VolumeAccessGroup
     
     def self.data
       @data ||= Hash.new do |hash, key|
@@ -53,8 +55,12 @@ module SolidfireApi
       # query is a hash that is post in json format to SolidFire API.
       solidfire_rest_url = "https://#{@username}:#{@password}@#{@mvip}/json-rpc/5.0"
       result = JSON.parse(RestClient.post solidfire_rest_url, query.to_json)
-      if result["result"].nil? 
-        return result["error"]
+      if result["result"].nil?
+        if result["error"].nil?
+          return result
+        else
+          return result["error"]
+        end
       else 
         return result["result"]
       end

data/lib/solidfire_api/version.rb

@@ -1,3 +1,3 @@
 module SolidfireApi
-  VERSION = "0.0.4"
+  VERSION = "0.0.6"
 end

data/lib/solidfire_api/volume_access_group.rb

@@ -0,0 +1,96 @@
+## 
+# Volume Access Group api calls
+#
+module VolumeAccessGroup
+  
+
+  ##
+  # list VolumeAccessGroups
+  # 
+  # Arguments:
+  #   state: (String, active or deleted, default = active)
+  #   limit: (Integer, default = 1000)
+  #
+  def vag_list()
+    api_call = {
+      :method => "ListVolumeAccessGroups",
+      :params => {}
+    }
+    answer = query_sf(api_call)
+    return answer["volumeAccessGroups"]
+  end
+
+  ##
+  # create VolumeAccessGroup
+  # return groupID
+  #
+  # Arguments:
+  #   group_name: (String, name of group)
+  #
+  # Require Admin credential
+  #
+  def vag_create(group_name)
+    api_call = {
+      :method => "CreateVolumeAccessGroup",
+      :params => {
+        :name => group_name,
+        :attributes => {}
+      }
+    }
+    answer = query_sf(api_call)
+    return answer["volumeAccessGroupID"]
+  end
+  
+  ##
+  # Add iSCSI initiator to VolumeAccessGroup
+  #
+  # Arguments: 
+  #   initiator: (String)
+  #   group_id: (Integer)
+  #
+  # Require Admin credential
+  #
+  def vag_add_initiator(initiator, group_id)
+    api_call = {
+      :method => "AddInitiatorsToVolumeAccessGroup",
+      :params => {
+        :volumeAccessGroupID => group_id,
+        :initiators => [ initiator ]
+      }
+    }
+    answer = query_sf(api_call)
+    return answer
+  end    
+
+  ##
+  # Add Volume to VolumeAccessGroup
+  #
+  # Arguments: 
+  #   volume_id: (Integer)
+  #   group_id: (Integer)
+  #
+  # Require Admin credential
+  #
+  def vag_add_volume_id(volume_id, group_id)
+    api_call = {
+      :method => "AddVolumesToVolumeAccessGroup",
+      :params => {
+        :volumeAccessGroupID => group_id,
+        :volumes => [ volume_id ]
+      }
+    }
+    answer = query_sf(api_call)
+    return answer
+  end   
+  
+  ##
+  # Add Volume to VolumeAccessGroup using names
+  #
+  #
+  def vag_add_volume(volume_name, vag_name)
+    volume_id = volumes_list().select {|s| s["name"] == volume_name }.first["volumeID"]
+    vag_id = vag_list().select {|s| s["name"] == vag_name }.first["volumeAccessGroupID"]
+    vag_add_volume_id(volume_id, vag_id)
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solidfire_api
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - Pierre-Luc Dion
@@ -57,6 +57,7 @@ files:
 - lib/solidfire_api/node.rb
 - lib/solidfire_api/version.rb
 - lib/solidfire_api/volume.rb
+- lib/solidfire_api/volume_access_group.rb
 - solidfire_api.gemspec
 homepage: https://github.com/pdion891/solidfire_api
 licenses: