shu-san-scripts 0.0.2 → 0.1.0

data/Gemfile

@@ -13,6 +13,12 @@ source "http://rubygems.org"
 # Command Line Interface Library
 gem "cri", "~> 2.0.2"
 
+# Library extensions
+gem "facets", ">= 2.4"
+
+# GUID library
+gem "uuidtools", "~> 2.1.2"
+
 ###
 ### Development Gems. All _additional_ gems required by development (as opposed to
 ###                   production environments). If it is required at run-time, it

data/Gemfile.lock

@@ -14,6 +14,7 @@ GEM
     riot (0.12.5)
       rr
     rr (1.0.4)
+    uuidtools (2.1.2)
     vclog (1.8.1)
       ansi (>= 1.2)
       facets (>= 2.4)
@@ -25,8 +26,10 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.0.0)
   cri (~> 2.0.2)
+  facets (>= 2.4)
   jeweler (~> 1.6.0)
   minitest
   riot
+  uuidtools (~> 2.1.2)
   vclog (~> 1.8.1)
   yard (~> 0.6.0)

data/HISTORY

@@ -17,13 +17,25 @@ Changes:
     * Version bump to 0.0.2. Added infrastructure needed for minimally working version
 
 
-HEAD / 2011-09-24
+HEAD / 2011-09-25
 
 Current Development (David Love)
 
 Changes:
 
-* 1 General Enhancements
+* 3 General Enhancements
 
+    * Version bump to 0.0.3
+    * Regenerate gemspec for version 0.0.2
     * Regenerate gemspec for version 0.0.2
 
+* 1 Bug Fixes
+
+    * Format options as well as the text description
+
+* 3 Patch Enhancements
+
+    * Add ability to generate the correct ZFS commands. Don't actually act on them yet
+    * Added support for sequential UUID's
+    * Require the Facets library in the main gem as well
+

data/README.rdoc

@@ -1,6 +1,6 @@
 = SHU SAN Scripts
 
-Together these scripts define a ''store'' command, used to simplify the
+Together these scripts define a +store+ command, used to simplify the
 task of creating iSCSI targets on OpenSolaris (Solaris > 11) based
 hosts. It has been tested on Nexenta NCP and Open Indiana, but with some
 modification it could be made to work on FreeBSD as well. 
@@ -25,16 +25,16 @@ available can be obtained by
 
 once everything has been installed.
 
-**Note:** The scripts assume they are running (or at least have access to)
-the ''root'' user role, as they will manipulate your ZFS volumes. You
+*Note:* The scripts assume they are running (or at least have access to)
+the +root+ user role, as they will manipulate your ZFS volumes. You
 can either install them with the appropriate privileges, or install the
-''sudo'' command to make life easier. With ''sudo''
++sudo+ command to make life easier. With +sudo+
 
   sudo store --help
 
 should get you started. 
 
-**Warning:** We use these scripts in a *teaching* environment, and so we
+*Warning:* We use these scripts in a _teaching_ environment, and so we
 assume the host they are running on is somewhat disposable. Your needs
 may differ...
 

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.1.0

data/lib/SANStore/cli/base.rb

@@ -51,7 +51,7 @@ module SANStore::CLI
       add_command(self.help_command)
 
       # Add other commands
-      #add_command(SANStore::CLI::Commands::NewVol.new)
+      add_command(SANStore::CLI::Commands::NewVol.new)
       #add_command(SANStore::CLI::Commands::ListVols.new)
     end
 

data/lib/SANStore/cli/commands.rb

@@ -26,5 +26,5 @@ end
 
 require 'SANStore/cli/commands/help'
 
-#require 'SANStore/cli/commands/new_vol'
+require 'SANStore/cli/commands/new_vol'
 #require 'SANStore/cli/commands/list_vols'

data/lib/SANStore/cli/commands/new_vol.rb

@@ -12,90 +12,106 @@
 # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
 # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
+# Volume names are based on RFC 4122 UUIDs
+require "uuidtools"
 
-module WhiteCloth::CLI::Commands
+# Use the ZFS library
+require "SANStore/zfs/zfs"
+
+# Use the COMStar iSCSI library
+require "SANStore/iSCSI/comstar.rb"
+
+module SANStore::CLI::Commands
 
   # @author David Love
   #
-  # The +bootstrap+ command prepared the basic WhiteCloth realms (if 
-  # needed), and then links the current host to those realms. The basic
-  # realms consists of
-  #
-  # +Realm 0+: *Namespace*. All the named realms stored in this domain.
-  # 
-  # +Realm 1+: *Realm Handlers*. The basic gateways needed to create/store/update
-  # other realms.
-  # 
-  # +Realm 5+: *Realm Code*. Libraries and other code which the realm handlers
-  # should use by preference when conducting operations on the realms.
-  #
-  # If the IP address of a server (or a server name) is given to as an argument
-  # to this command, then we will use that IP address (name) for as the WhiteCloth
-  # realm server to contact. Otherwise we will look for the same data from the file
-  # +/etc/whitecloth.conf+: aborting if the file cannot be found.
-  #
-  # Once we have made contact with the server, we look at the basic realms listed
-  # above, and attempt to ensure they can be found. If not, an attempt is made to
-  # create the basic realms: aborting if this attempt fails.
-  #
-  # Finally, once everything has been set-up, we upload the core realm code (or 
-  # update the existing code)
-  class Bootstrap < Cri::Command
+  # The +new_vol+ command adds a new ZFS volume to the specified volume
+  # store, and sets it up as an iSCSI target. Defaults are supplied to
+  # all arguments, but can be overridden by the user for slightly
+  # customised set-up of the volume store. However, the user interface
+  # should be kept as simple as possible. 
+  class NewVol < Cri::Command
 
     # The name of the sub-command (as it appears in the command line app)
     def name
-      'bootstrap'
+      'new_vol'
     end
 
     # The aliases this sub-command is known by
     def aliases
-      []
+      [
+        "new", "add", "add_vol"
+      ]
     end
 
     # A short help text describing the purpose of this command
     def short_desc
-      'Create a link between this host and the whitecloth servers.'
+      'Create a new iSCSI volume in the SAN volume store.'
     end
 
     # A longer description, detailing both the purpose and the
     # use of this command
     def long_desc
-      'Look for the specified server, adding the data required to link the ' +
-      'current host to that server. If the found server has not been set-up ' +
-      'then this command also performs the setup of the base realms as well. '
+      'By default, this command creates a 20G ZFS volume, and marks it for ' +
+      'sharing as an iSCSI target on the local network.' + "\n\n" +
+      'Warning: By default this commands sets up the iSCSI target with NO ' +
+      'security. This is fine for testing and use in the labs, but obviously ' +
+      'is not ideal if you care about the data stored on this new volume...'
     end
 
     # Show the user the basic syntax of this command
     def usage
-      "whitecloth bootstrap [-s server]"
+      "store new_volume [--volume-store ZFS_PATH][--name GUID] [--size INTEGER]"
     end
     
     # Define the options for this command
     def option_definitions
       [
-        { :short => 's', :long => 'server', :argument => :optional }
+        { :short => 'v', :long => 'volume_store', :argument => :optional,
+          :desc => 'specifify the ZFS root of the new iSCSI volume. Defaults to "store/volumes".'
+        },
+        { :short => 'n', :long => 'name', :argument => :optional,
+          :desc => 'the name of the new volume. This must be a valid ZFS volume name, and defaults to ' +
+            'an RFC 4122 GUID.'
+        },
+        { :short => 's', :long => 'size', :argument => :optional,
+          :desc => 'the size of the new iSCSI volume. Note that while ZFS allows you to change the size ' +
+            'of the new volume relatively easily, because the iSCSI initiator sees this volume as a raw ' +
+            'device changing the size later may be very easy or very difficult depending on the initiators ' +
+            'operating system (and the specific file system being used). In other words, choose with care: ' +
+            'by default this command uses a size of 20G, which should be enough for most tasks in the labs.'  
+        },
       ]
     end
 
     # Execute the command
     def run(options, arguments)
+
+      # Look at the options, and if we don't find any (or some are
+      # missing), set them to the default values
+      if options[:volume_store].nil? or options[:volume_store].empty? then
+        volume_store = "store/volumes"
+        options[:volume_store] = volume_store
+      end
       
-      # The first thing we need to do is to find the relevant server. So we 
-      # check the options and see if they can help
-      unless options[:server].nil? or options[:server].empty? then
-        #
-      else
+      if options[:name].nil? or options[:name].empty? then
+        name = UUIDTools::UUID.timestamp_create
+        options[:name] = name.to_s
+      end
       
-        # The user has not specified a server, so we will attempt to get one
-        # from the system configuration
-        if File.exists?("/etc/whitecloth.conf") then
-          #
-        
-        # Everything has failed, so we abort        
-        else
-          WhiteCloth::CLI::Logger.instance.log_level(:high, :error, "Cannot locate a WhiteCloth server. Either specify the server to connect to using the 'server' option, or create an appropriate configuration file.")
-        end
-      end  
+      if options[:size].nil? or options[:size].empty? then
+        size = "20G" 
+        options[:size] = size
+      end
+
+      # Ask for a new volume
+      ZFS.new_volume(options[:volume_store] + "/" + options[:name], options[:size]) 
+
+      # Set the volume up as an iSCSI target
+      target_name = COMStar.new_target(options[:volume_store] + "/" + options[:name])
+
+      # Tell the caller what the new volume name is
+      puts target_name
     end
 
   end

data/lib/SANStore/cri/command.rb

@@ -86,7 +86,7 @@ module Cri
         text << "options:\n"
         text << "\n"
         option_definitions.sort { |x,y| x[:long] <=> y[:long] }.each do |opt_def|
-          text << sprintf("    -%1s --%-10s %s\n", opt_def[:short], opt_def[:long], opt_def[:desc])
+          text << sprintf("    -%1s --%-10s %s\n\n", opt_def[:short], opt_def[:long], opt_def[:desc].wrap_and_indent(78, 20).lstrip)
         end
       end
 

data/lib/SANStore/helpers/uuid.rb

@@ -0,0 +1,35 @@
+# Copyright (c) 2010-2011 David Love
+#
+# Permission to use, copy, modify, and/or distribute this software for 
+# any purpose with or without fee is hereby granted, provided that the 
+# above copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#
+
+# @author David Love
+
+require "uuidtools"
+
+# Extendes the {UUIDTools::UUID} class, adding the ability to
+# generate sequential UUID's
+class UUIDTools::UUID
+  
+  # Increments the internal UUID representation, returning a
+  # new UUID that is different from, but greater, than the 
+  # current sequence number
+  def next
+    next_uuid = self.to_i
+    next_uuid += 1
+    
+    # Return the newly created UUID
+    return UUIDTools::UUID::parse_int(next_uuid)
+  end
+  
+end

data/lib/SANStore/iSCSI/comstar.rb

@@ -0,0 +1,45 @@
+# Copyright (c) 2010-2011 David Love
+#
+# Permission to use, copy, modify, and/or distribute this software for 
+# any purpose with or without fee is hereby granted, provided that the 
+# above copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#
+
+# @author David Love
+
+# Defines a class capable of creating iSCSI shares using the new
+# COMStar framework. This classes uses the various command line tools, 
+# not the C API.
+class COMStar
+  
+  # Create a new, ready to use, iSCSI target. Functionally this is command
+  # is equivalent to the old "shareiscsi=on" ZFS volume property.
+  def self.new_target(volume_path)
+    
+    # Create a new disk target for the ZFS volume
+    disk_target = %x[sbdadm create-lu /dev/zvol/rdsk/#{volume_path}]
+
+    # Get the GUID of the new disk target from the output of the
+    # target creation command
+    guid = disk_target.split(/$/)[4].split[0]
+    
+    # Link the new disk target to the iSCSI framework
+    vol_frame = %x[stmfadm add-view #{guid}]
+
+    # Finally create the target...
+    target = %x[itadm create-target]
+
+    #... and return the name to the caller
+    target_name = target.split[1]
+  end
+
+end
+  

data/lib/SANStore/zfs/zfs.rb

@@ -0,0 +1,36 @@
+# Copyright (c) 2010-2011 David Love
+#
+# Permission to use, copy, modify, and/or distribute this software for 
+# any purpose with or without fee is hereby granted, provided that the 
+# above copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#
+
+# @author David Love
+
+# Defines a class capable of manipulating ZFS volumes. This classes uses
+# the standard command line tools (+zfs+ and +zpool+), not the C API.
+class ZFS
+  
+  # Create a new volume, at the specified location and of the specified
+  # size.
+  #
+  # NOTE: This command currently only supports the creation of sparse
+  # volumes. If you really need pre-allocated volumes for some reason,
+  # this command needs to be extended
+  def self.new_volume(volume_path, volume_size)
+    
+    # Create the volume
+    cmd = %x[zfs create -s -V #{volume_size} #{volume_path}]
+
+  end
+
+end
+  

data/shu-san-scripts.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{shu-san-scripts}
-  s.version = "0.0.2"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{David Love}]
-  s.date = %q{2011-09-23}
+  s.date = %q{2011-09-24}
   s.description = %q{See the README file.}
   s.email = %q{david@homeunix.org.uk}
   s.executables = [%q{store}]
@@ -42,6 +42,9 @@ Gem::Specification.new do |s|
     "lib/SANStore/cri/core_ext.rb",
     "lib/SANStore/cri/core_ext/string.rb",
     "lib/SANStore/cri/option_parser.rb",
+    "lib/SANStore/helpers/uuid.rb",
+    "lib/SANStore/iSCSI/comstar.rb",
+    "lib/SANStore/zfs/zfs.rb",
     "shu-san-scripts.gemspec",
     "test/helper.rb",
     "test/test_shu-san-scripts.rb"
@@ -57,6 +60,8 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<cri>, ["~> 2.0.2"])
+      s.add_runtime_dependency(%q<facets>, [">= 2.4"])
+      s.add_runtime_dependency(%q<uuidtools>, ["~> 2.1.2"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.0"])
       s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
@@ -65,6 +70,8 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<riot>, [">= 0"])
     else
       s.add_dependency(%q<cri>, ["~> 2.0.2"])
+      s.add_dependency(%q<facets>, [">= 2.4"])
+      s.add_dependency(%q<uuidtools>, ["~> 2.1.2"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
       s.add_dependency(%q<yard>, ["~> 0.6.0"])
@@ -74,6 +81,8 @@ Gem::Specification.new do |s|
     end
   else
     s.add_dependency(%q<cri>, ["~> 2.0.2"])
+    s.add_dependency(%q<facets>, [">= 2.4"])
+    s.add_dependency(%q<uuidtools>, ["~> 2.1.2"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
     s.add_dependency(%q<yard>, ["~> 0.6.0"])

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 2
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors: 
 - David Love
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-23 00:00:00 Z
+date: 2011-09-24 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :runtime
@@ -34,8 +34,39 @@ dependencies:
   name: cri
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :development
+  type: :runtime
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 4
+        version: "2.4"
+  version_requirements: *id002
+  name: facets
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 1
+        - 2
+        version: 2.1.2
+  version_requirements: *id003
+  name: uuidtools
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -46,12 +77,12 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  version_requirements: *id002
+  version_requirements: *id004
   name: bundler
   prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -62,12 +93,12 @@ dependencies:
         - 6
         - 0
         version: 1.6.0
-  version_requirements: *id003
+  version_requirements: *id005
   name: jeweler
   prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -78,12 +109,12 @@ dependencies:
         - 6
         - 0
         version: 0.6.0
-  version_requirements: *id004
+  version_requirements: *id006
   name: yard
   prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -94,12 +125,12 @@ dependencies:
         - 8
         - 1
         version: 1.8.1
-  version_requirements: *id005
+  version_requirements: *id007
   name: vclog
   prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -108,12 +139,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  version_requirements: *id006
+  version_requirements: *id008
   name: minitest
   prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -122,7 +153,7 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  version_requirements: *id007
+  version_requirements: *id009
   name: riot
   prerelease: false
 description: See the README file.
@@ -159,6 +190,9 @@ files:
 - lib/SANStore/cri/core_ext.rb
 - lib/SANStore/cri/core_ext/string.rb
 - lib/SANStore/cri/option_parser.rb
+- lib/SANStore/helpers/uuid.rb
+- lib/SANStore/iSCSI/comstar.rb
+- lib/SANStore/zfs/zfs.rb
 - shu-san-scripts.gemspec
 - test/helper.rb
 - test/test_shu-san-scripts.rb