solidfire_api 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b56e12283613e5ad515ff8fa602ee2621d05e667
-  data.tar.gz: a26152c4bc5b7e02815429bd39effe2afb9b4d52
+  metadata.gz: 197ba47760fa5e1508dde1f6cce7cd7c50db5250
+  data.tar.gz: 8568fef138ef8ed357416bcbe2f4ce575336cc72
 SHA512:
-  metadata.gz: 57e5d7d74e05594c9e52327cd8da9bafe33dbfb1b9629d739057715b817424a057ab1237de9b4b031eba9c35f57167de8b4d1303e1dd78b7f78e16c4bb47bf65
-  data.tar.gz: b094d68e567cce18e33b961ff36f08de7327d7b407f902749be3d752a9e895a6a8e68bcfab973558b52195abf78d67dce4efd6d524357f8cf449bea7b0ec890e
+  metadata.gz: bf73a214def5e614ba5e69352d9fbd8d0a3320131c3f51a832f426d0554272b7ebda99810f6c375f12cfdf3c31c74e541300ce12e2608a9f4c5f4b8d6c63ab97
+  data.tar.gz: 948996a996ca3e1e9e72bda4fceeb2dac98d6dceb6ae8e68ecd91910e1b9f9f3c3034459ba3325acdf38b040d24d9ab963958452d6686ae95b26ac6f1d018b31

data/README.md

@@ -1,9 +1,17 @@
 # SolidfireApi
 
-Ruby Gem to connect on Solidfire storage Array API to collect stats. Currently support Simple Authentication and very basic functionality.
+Ruby Gem to connect on Solidfire storage Array API to collect stats. Currently support Simple Authentication and very basic functionalities.
+
+Use gem: RestClient to interract with Solidfire API. 
 
 ## Installation
 
+Gems requirements:
+
+* rest_client
+* net/http
+* json 
+
 Install it:
 
     $ gem install solidfire_api
@@ -20,6 +28,8 @@ Install it:
     :username => "monitor",
     :password =>  "patate"
   })
+
+  # Some method examples:
   my_sf.name
   my_sf.mvip
   my_sf.svip
@@ -27,12 +37,12 @@ Install it:
   
 ```
 
-Currently supporting volumes and cluster listing and stats API call's to collect perf metric for monitoring usage. Nothing for managing cluster yet.
+Currently supporting volumes and cluster listing and stats API call's to collect performance metrics for monitoring usage. Nothing for managing cluster yet.
 
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/solidfire_api/fork )
+1. Fork it ( http://github.com/pdion891/solidfire_api/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/solidfire_api.rb

@@ -4,6 +4,7 @@ require 'json'
 
 Dir[File.join(File.dirname(__FILE__), 'solidfire_api/*.rb')].sort.each { |lib| require lib }
 
+
 module SolidfireApi
 
 end    

data/lib/solidfire_api/cluster.rb

@@ -1,7 +1,14 @@
-
+##
+# Cluster
+# 
+# Cluster related API calls 
+#
 
 module Cluster
 
+  ##
+  # cluster_state: require administrative account.
+  #
   def cluster_state()
     api_call = {
       :method => "GetClusterState",
@@ -11,7 +18,10 @@ module Cluster
     answer = query_sf(api_call)
     return answer
   end
-  
+
+  ##
+  # Cluster Information such as hostname, mvip,svip,...
+  #  
   def cluster_info()
     api_call = {
       :method => "GetClusterInfo",
@@ -22,27 +32,52 @@ module Cluster
     return answer["clusterInfo"]
   end
   
-  def drives_list()
+  ##
+  # Cluster firmware version including nodes
+  #
+  def cluster_version()
     api_call = {
-      :method => "ListDrives",
+      :method => "GetClusterVersionInfo",
       :params => {
       }
     }
     answer = query_sf(api_call)
-    return answer["drives"]
-  end
-  
-  def drive_stats(drive_id)
+    return answer["clusterVersion"]
+  end  
+  ##
+  # Cluster performance metrics, overall IOPS,..
+  #  
+  def cluster_stats()
     api_call = {
-      :method => "GetDriveStats",
+      :method => "GetClusterStats",
       :params => {
-        :driveID => drive_id
       }
     }
     answer = query_sf(api_call)
-    return answer["result"]
-  end
+    return answer["clusterStats"]
+  end  
+
+  ##
+  # Cluster capacity 
+  #
+  def cluster_capacity()
+    api_call = {
+      :method => "GetClusterCapacity",
+      :params => {
+      }
+    }
+    answer = query_sf(api_call)
+    return answer["clusterCapacity"]
+  end 
+  
+
   
+  ##
+  # List all account, return Array of Hash
+  #
+  # Arguments:
+  #   limit: (integer, default=1000)
+  #  
   def accounts_list(limit = 1000)
     api_call = {
       :method => "ListAccounts",
@@ -55,5 +90,25 @@ module Cluster
     return answer["accounts"]
   end
 
+  ##
+  # List Cluster Faults
+  # 
+  # Arguments:
+  #  fault_type: (node,drive,cluster,service, default=all)
+  #       node: Fault affecting an entire node
+  #       drive: Fault affecting an individual drive
+  #       cluster: Fault affecting the entire cluster
+  #       service: Fault affecting a service on the cluster
+  def faults_list(fault_type = "all")
+    api_call = {
+      :method => "ListClusterFaults",
+      :params => {
+        :faultTypes => fault_type
+      }
+    }
+    answer = query_sf(api_call)
+    return answer["faults"]
+  end
+
 end
 

data/lib/solidfire_api/connection.rb

@@ -1,10 +1,24 @@
+# Load libraries
 require 'solidfire_api/volume'
+require 'solidfire_api/node'
+require 'solidfire_api/cluster'
 
 module SolidfireApi
   
+  ##
+  # Object connection 
+  #
+  # Call using:  SolidfireApi::Connection.new({...})
+  #
+  # Arguments:
+  #   mvip: (String)
+  #   username: (String)
+  #   password: (String)
+  # 
   class Connection    
     include Cluster
     include Volume
+    include Node
     
     def self.data
       @data ||= Hash.new do |hash, key|
@@ -16,6 +30,25 @@ module SolidfireApi
       @data = nil
     end
     
+    ##
+    # 
+    # Used by all other methods to connect at the SolidFire API
+    # require RestClient gem to handle Rest API calls.
+    # the input is the complete API query as Hash, the method will
+    # send the query as json request to the Solidfire API.
+    #
+    # Example:
+    #   >> api_call = {
+    #   >>   :method => "GetClusterInfo",
+    #   >>   :params => {
+    #   >>    }
+    #   >> }
+    #   >> query_sf(api_call)
+    #
+    # 
+    # Arguments:
+    #   query: (Hash)
+    #      must include the complete Solidfire API query string.
     def query_sf(query)
       # query is a hash that is post in json format to SolidFire API.
       solidfire_rest_url = "https://#{@username}:#{@password}@#{@mvip}/json-rpc/5.0"

data/lib/solidfire_api/node.rb

@@ -0,0 +1,81 @@
+##
+# Node
+# 
+# API call related to cluster nodes
+#
+module Node
+  
+  ##
+  #
+  # List cluster nodes
+  # 
+  # Arguments:
+  # 
+  #  state: (String, default = active)
+  #       active
+  #       all
+  def nodes_list(state = "active")
+    case state
+    when "all"
+      api_call = {
+        :method => "ListAllNodes",
+        :params => {}
+      }
+    when "active"
+      api_call = {
+        :method => "ListActiveNodes",
+        :params => {}
+      }
+    end
+    answer = query_sf(api_call)
+    return answer["nodes"]
+  end  
+  ##
+  # node performance metrics
+  #
+  # Arguments:
+  #   node_id: (Integer)
+  #
+  def node_stats(node_id)
+    api_call = {
+      :method => "GetNodeStats",
+      :params => {
+        :nodeID => node_id
+      }
+    }
+    answer = query_sf(api_call)
+    return answer["nodeStats"]
+  end
+  
+  ##
+  # provide list of disks in a Array of hash.
+  #  
+  def drives_list()
+    api_call = {
+      :method => "ListDrives",
+      :params => {
+      }
+    }
+    answer = query_sf(api_call)
+    return answer["drives"]
+  end
+  
+  ##
+  # hard drive performance metric, return in Hash.
+  # 
+  # Arguments:
+  #   drive_id: (Integer)
+  #
+  def drive_stats(drive_id)
+    api_call = {
+      :method => "GetDriveStats",
+      :params => {
+        :driveID => drive_id
+      }
+    }
+    answer = query_sf(api_call)
+    return answer["driveStats"]
+  end
+  
+  
+end

data/lib/solidfire_api/version.rb

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

data/lib/solidfire_api/volume.rb

@@ -1,17 +1,40 @@
 module Volume
   
-  def volumes_list(limit = 1000)
-    api_call = {
-      :method => "ListActiveVolumes",
-      :params => {
-        :startVolumeID => 0,
-        :limit => limit
+
+  ## 
+  # list active volumes, return Array of Hash
+  #
+  # Arguments:
+  #   state: (String, active or deleted, default = active)
+  #   limit: (Integer, default = 1000)
+  #
+  def volumes_list(state = "active", limit = "1000")
+    case state
+    when "active"
+      api_call = {
+        :method => "ListActiveVolumes",
+        :params => {
+          :startVolumeID => 0,
+          :limit => 1000
+        }
       }
-    }
+    when "deleted"
+      api_call = {
+        :method => "ListDeletedVolumes",
+        :params => {}
+      }
+    end
     answer = query_sf(api_call)
     return answer["volumes"]
   end
   
+  ##
+  # return volume performance metrics as Hash
+  #
+  # Arguments:
+  #  vol_id: (Integer)
+  #      Volume ID from the Solidfire Cluster.
+  #
   def volume_stats(vol_id)
     api_call = {
       :method => "GetVolumeStats",
@@ -23,6 +46,12 @@ module Volume
     return answer["volumeStats"]
   end
   
+  ##
+  # Return volumes list per account
+  # 
+  # Arguments:
+  #   accountid: (Integer)
+  # 
   def volumes_for_account(accountid)
     api_call = {
       :method => "ListVolumesForAccount",
@@ -34,6 +63,7 @@ module Volume
     return answer["result"]
   end 
   
+  
   def volumes_stats_by_account()
     api_call = {
       :method => "ListVolumeStatsByAccount",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solidfire_api
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Pierre-Luc Dion
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-09 00:00:00.000000000 Z
+date: 2014-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -51,10 +51,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/.DS_Store
 - lib/solidfire_api.rb
 - lib/solidfire_api/cluster.rb
 - lib/solidfire_api/connection.rb
+- lib/solidfire_api/node.rb
 - lib/solidfire_api/version.rb
 - lib/solidfire_api/volume.rb
 - solidfire_api.gemspec