OodCluster

A library used to describe an HPC center cluster and its resources.

Installation

Add this line to your application's Gemfile:

gem 'ood_cluster'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ood_cluster

Usage

Typically you would read in all the cluster information from a YAML file. There is an example yaml configuration file included with this repo:

require 'ood_cluster'

# Read in example json file for OSC clusters
require 'json'
JSON.create_id = "type"
osc_clusters = JSON.load(File.read("config/clusters.json"))['v1']#=>
#{
#  "oakley" => #<OodCluster::Cluster>,
#  "ruby"   => #<OodCluster::Cluster>,
#  "quick"  => #<OodCluster::Cluster>,
#}


# Read in example yaml file for OSC clusters
require 'yaml'
osc_clusters = JSON.load(JSON.dump(YAML.load(File.read("config/clusters.yml"))))['v1']#=>
#{
#  "oakley" => #<OodCluster::Cluster>,
#  "ruby"   => #<OodCluster::Cluster>,
#  "quick"  => #<OodCluster::Cluster>,
#}

Given a cluster object you could then get connection information for the various servers hosted by the cluster.

# Play with the Oakley cluster
oakley = osc_clusters["oakley"]#=> #<OodCluster::Cluster>


# Check if Oakley has a Resource Manager server
oakley.resource_mgr_server?#=> true


# Check the type of server this is
oakley.resource_mgr_server.class#=> OodCluster::Servers::Torque


# Get the status of this Torque server through the pbs-ruby library
oakley.resource_mgr_server.pbs.get_status#=>
#{
#  "oak-batch.osc.edu:15001" => {
#    :server_state => "Idle",
#    :total_jobs => "1866",
#    :default_queue => "batch",
#    ...
#  }
#}

Servers

From the cluster you can query server information using the following syntax:

# Check whether server exists on this cluster
#   my_cluster.<server>_server?
my_cluster.ganglia_server?#=> true


# Grab the server object
#   my_cluster.<server>_server
ganglia = my_cluster.ganglia_server#=> #<OodCluster::Servers::Ganglia>

Torque

This can be a resource_mgr_server for a cluster.

# Assign torque server
torque_server = my_cluster.resource_mgr_server#=> #<OodCluster::Servers::Torque>


# Get host information
torque_server.host#=> "oak-batch.osc.edu"


# Get client software information
torque_server.lib.to_s#=> "/usr/local/torque/default/lib"

Communication with this server can then be handled through the pbs Ruby gem. Please see https://github.com/OSC/pbs-ruby for more information on how to use the pbs gem.

Moab

This can be a scheduler_server for a cluster.

# Assign moab server
moab_server = my_cluster.scheduler_server#=> #<OodCluster::Servers::Moab>


# Get host information
moab_server.host#=> "oak-batch.osc.edu"


# Get client software information
moab_server.bin.to_s#=> "/usr/local/moab/default/bin"

Communication with this server can then be handled through the moab Ruby gem. Please see https://github.com/OSC/moab-ruby for more information on how to use the moab gem.

Ganglia

If a cluster has a ganglia server, then communication is handled client side through the browser. So the responsibility of the Ganglia server object is to generate URIs for the client.

# Get URI used to access the web server
ganglia_server.uri.to_s#=> "https://www.hpc.edu/gweb/graph.php?c=MyCluster"


# Add query values as options for the server
ganglia_server.uri(query_values: {g: 'cpu_report'}).to_s#=> "https://www.hpc.edu/gweb/graph.php?c=MyCluster&g=cpu_report"

Contributing

  1. Fork it ( https://github.com/[my-github-username]/ood_cluster/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)
  5. Create a new Pull Request