shu-san-scripts 0.1.0 → 0.1.1

data/README.rdoc

@@ -38,6 +38,60 @@ should get you started.
 assume the host they are running on is somewhat disposable. Your needs
 may differ...
 
+== Synopsis
+
+General help can be obtained by running +store --help+, or +store+ with no
+arguments
+
+  A command-line tool for managing iSCSI targets on OpenSolaris.
+
+  Available commands:
+
+      help                 Show help for a command
+      new_vol              Create a new iSCSI volume in the SAN volume store.
+
+  Global options:
+
+      -h --help            show this help message and quit
+      -C --no-color        disable color
+      -V --verbose         make store command output more detailed
+      -v --version         show version information and quit
+      
+Help on individual commands can then be obtained using the command as an
+argument to +store help+. For instance
+
+  # store help new_vol
+  
+produces
+
+  store new_volume [--volume-store ZFS_PATH][--name GUID] [--size INTEGER]
+
+  aliases: new add add_vol
+
+  Create a new iSCSI volume in the SAN volume store.
+
+      By default, this command creates a 20G ZFS volume, and marks it for sharing
+      as an iSCSI target on the local network.
+
+      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...
+
+  options:
+
+      -n --name       the name of the new volume. This must be a valid ZFS volume name, and
+                      defaults to an RFC 4122 GUID.
+
+      -s --size       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.
+
+      -v --volume_store specifify the ZFS root of the new iSCSI volume. Defaults to "store/volumes".
+
 == Contributing to the SHU SAN Scripts
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: shu-san-scripts
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - David Love
@@ -65,8 +65,23 @@ dependencies:
   name: uuidtools
   prerelease: false
 - !ruby/object:Gem::Dependency 
-  type: :development
+  type: :runtime
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 2
+        version: "1.2"
+  version_requirements: *id004
+  name: ansi
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -77,12 +92,12 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
-  version_requirements: *id004
+  version_requirements: *id005
   name: bundler
   prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -93,12 +108,12 @@ dependencies:
         - 6
         - 0
         version: 1.6.0
-  version_requirements: *id005
+  version_requirements: *id006
   name: jeweler
   prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -109,12 +124,12 @@ dependencies:
         - 6
         - 0
         version: 0.6.0
-  version_requirements: *id006
+  version_requirements: *id007
   name: yard
   prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -125,12 +140,12 @@ dependencies:
         - 8
         - 1
         version: 1.8.1
-  version_requirements: *id007
+  version_requirements: *id008
   name: vclog
   prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -139,12 +154,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  version_requirements: *id008
+  version_requirements: *id009
   name: minitest
   prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -153,49 +168,21 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  version_requirements: *id009
+  version_requirements: *id010
   name: riot
   prerelease: false
 description: See the README file.
 email: david@homeunix.org.uk
-executables: 
-- store
+executables: []
+
 extensions: []
 
 extra_rdoc_files: 
 - LICENSE.txt
 - README.rdoc
 files: 
-- .document
-- .rvmrc
-- Gemfile
-- Gemfile.lock
-- HISTORY
 - LICENSE.txt
 - README.rdoc
-- Rakefile
-- VERSION
-- bin/store
-- lib/SANStore.rb
-- lib/SANStore/cli.rb
-- lib/SANStore/cli/base.rb
-- lib/SANStore/cli/commands.rb
-- lib/SANStore/cli/commands/help.rb
-- lib/SANStore/cli/commands/list_vols.rb
-- lib/SANStore/cli/commands/new_vol.rb
-- lib/SANStore/cli/logger.rb
-- lib/SANStore/cri.rb
-- lib/SANStore/cri/base.rb
-- lib/SANStore/cri/command.rb
-- 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
 homepage: http://github.com/dlove24/shu-san-scripts
 licenses: 
 - ISC
@@ -225,7 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Scripts used to set-up and manage iSCSI targets on OpenSolaris (ZFS) systems.

data/.document

@@ -1,5 +0,0 @@
-lib/**/*.rb
-bin/*
-- 
-features/**/*.feature
-LICENSE.txt

data/.rvmrc

@@ -1,27 +0,0 @@
-ruby_string="ruby-1.8.7-p352"
-gemset_name="san-scripts"
-
-if rvm list strings | grep -q "${ruby_string}" ; then
-
-  # Load or create the specified environment
-  if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
-    && -s "${rvm_path:-$HOME/.rvm}/environments/${ruby_string}@${gemset_name}" ]] ; then
-    \. "${rvm_path:-$HOME/.rvm}/environments/${ruby_string}@${gemset_name}"
-  else
-    rvm --create  "${ruby_string}@${gemset_name}"
-  fi
-
-  # Ensure that Bundler is installed, install it if it is not.
-  if ! command -v bundle ; then
-    gem install bundler
-  fi
-
-  # Bundle while reducing excess noise.
-  bundle | grep -v 'Using' | grep -v 'complete' | sed '/^$/d'
-
-else
-
-  # Notify the user to install the desired interpreter before proceeding.
-  echo "${ruby_string} was not found, please run 'rvm install ${ruby_string}' and then cd back into the project directory."
-
-fi

data/Gemfile

@@ -1,40 +0,0 @@
-###
-### Sources
-###
-
-# Main Ruby Gems site
-source "http://rubygems.org"
-
-###
-### Core Gems. These are required in _all_ environments (additional environments
-###            follow).
-###
-
-# 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
-###                   belongs above.
-group :development do
-
-  # Gem management tools
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.6.0"
-  
-  # Documentation Tools
-  gem "yard", "~> 0.6.0"
-  gem "vclog", "~> 1.8.1"
-  
-  # Testing Tools
-  gem "minitest", ">= 0"
-  gem "riot"
-
-end

data/Gemfile.lock

@@ -1,35 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    ansi (1.3.0)
-    cri (2.0.2)
-    facets (2.9.2)
-    git (1.2.5)
-    jeweler (1.6.4)
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      rake
-    minitest (2.6.0)
-    rake (0.9.2)
-    riot (0.12.5)
-      rr
-    rr (1.0.4)
-    uuidtools (2.1.2)
-    vclog (1.8.1)
-      ansi (>= 1.2)
-      facets (>= 2.4)
-    yard (0.6.8)
-
-PLATFORMS
-  ruby
-
-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

@@ -1,41 +0,0 @@
-RELEASE HISTORY
-
-v0.0.2 / 2011-09-23
-
-Regenerate gemspec for version 0.0.2 (David Love david@homeunix.org.uk)
-
-Changes:
-
-* 3 General Enhancements
-
-    * Version bump to 0.0.1
-    * Version bump to 0.0.0
-    * Initial commit to shu-san-scripts.
-
-* 1 Patch Enhancements
-
-    * Version bump to 0.0.2. Added infrastructure needed for minimally working version
-
-
-HEAD / 2011-09-25
-
-Current Development (David Love)
-
-Changes:
-
-* 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/Rakefile

@@ -1,45 +0,0 @@
-# encoding: utf-8
-
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "shu-san-scripts"
-  gem.homepage = "http://github.com/dlove24/shu-san-scripts"
-  gem.license = "ISC"
-  gem.summary = %Q{Scripts used to set-up and manage iSCSI targets on OpenSolaris (ZFS) systems.}
-  gem.description = %Q{See the README file.}
-  gem.email = "david@homeunix.org.uk"
-  gem.authors = ["David Love"]
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "shu-san-scripts #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/VERSION

@@ -1 +0,0 @@
-0.1.0

data/bin/store

@@ -1,50 +0,0 @@
-#!/usr/bin/env ruby
-
-### Copyright (c) 2011 David Love <david@homeunix.org.uk>
-###
-### 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
-###
-### Boot straping Command. Used to initalize various aspects of the Mercury
-### environment.
-###
-### @note The sub-commands provided by the bootstrap command assume (at-least)
-### a minimally working Ruby environment, with the required gems installed. Various
-### 'First Boot' scripts are available in the `scripts` directory for different
-### platforms which will achieve at least this minimal state
-###
-
-# Add lib to load path
-$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/../lib'))
-
-# Load the rubygems library
-require 'rubygems'
-
-# Load core application library
-require 'SANStore'
-
-# Load command line handler
-require 'SANStore/cri'
-require 'SANStore/cli'
-
-# Load the commands from the cmds dir
-plugin_dir = File.expand_path(File.dirname(__FILE__) + '/../cmds')
-
-Dir[plugin_dir + '/*.rb'].sort.each{|file|
-  require file
-}
-
-# Run base
-SANStore::CLI::Base.new.run(ARGV)