fissher 1.0.2

data/README.rdoc

@@ -0,0 +1,39 @@
+
+== Fissher
+
+Fissher is a simple utility to run commands on multiple servers, powered by Net::SSH::Multi.
+
+=== Usage
+
+  fissher [flags] [command]
+    -G Hostgroup       Execute command on all hosts listed in the JSON config for the
+                       specified group.
+    -H Host1,Host2     Execute command on hosts listed on the command line
+    -g jumpbox         Manually specify/override a jump server, if necessary.
+    -s 		     Execute the provided commands with sudo.
+    -u username        Manually specify/override username to connect with.
+    -p                 Use password based authentication, specified via STDIN
+    -c config.json     Manually specify the path to your fissher config file
+    -n num             Number of concurrent connections. Enter 0 for unlimited.
+
+=== Installation
+
+==== Via Rubygems (Recommended)
+
+Simply run the following:
+
+  gem install fissher
+
+==== Manual
+
+* Place the code into a directory by either unarchiving it or checking it out via git.
+* Run bundler to install the dependency gems (getopt, net-ssh-multi, net-ssh-session, json, highline)
+
+=== JSON Config file
+
+This file, by default, lives in the etc directory one level below where
+the main script lives. You can specify it manually with the -c option.
+
+There is a sample configuration file provided with the script that displays
+all of the currently configurable options. Any variables can be omitted
+or overridden with command line options.

data/bin/fissher

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.dirname(__FILE__) + '/../lib'
+
+require 'fissher_base'
+
+fissher = FissherBase.new
+
+fissher.go_time

data/etc/fissher.conf.sample

@@ -0,0 +1,14 @@
+{
+  "user": "user",				   // Default user name
+  "concurrency": "10", 				   // Set to 0 to disable max concurrency
+  "default_gateway": "jumpbox1.sampledomain.com",  // Default jump box, if needed.
+  "hostgroups": {				   
+    "app": {
+      "gateway": "jumpbox2.sampledomain.com",  // Override the default
+      "hosts": ["appsrv01","appsrv02","appsrv03","appsrv04"] 
+    },
+    "web": {
+      "hosts": ["websrv01","websrv02"]
+    }
+  }
+}

data/lib/fissher_base.rb

@@ -0,0 +1,53 @@
+
+$:.unshift File.dirname(__FILE__)
+
+require 'rubygems'
+require 'net/ssh/multi'
+require 'fissher_conf'
+include FissherConf
+
+class FissherBase
+  def go_time
+    opts = FissherConf.handle_opts unless !opts.nil?
+    abort "No hosts specified! Please use -H or -G!\n" unless !opts[:hostlist].nil?
+
+    Net::SSH::Multi.start(:concurrent_connections => opts[:concurrency]) do |session|
+      if opts[:gateway]
+        session.via opts[:gateway], opts[:user], :password => opts[:password]
+      end
+
+      # Create our connection list
+      opts[:hostlist].each do |host|
+        session.use host, :user => opts[:user], :password => opts[:password]
+      end
+
+      if opts[:command] =~ /^sudo/
+        if opts[:password].nil?
+          p = FissherConf::Misc.new
+          opts[:password] = p.getpass
+        end
+
+        # Get a PTY and exec command on servers
+        session.open_channel do |ch|
+          ch.request_pty do |c, success|
+            raise "could not request pty" unless success
+            ch.exec opts[:command]
+            ch.on_data do |c_, data|
+              if data =~ /\[sudo\]/
+                ch.send_data(opts[:password] + "\n")
+              else
+                puts "[#{ch[:host]}]: #{data}" unless data =~ /^\n$|^\s*$/
+              end
+            end
+          end
+        end
+      else
+        # Sudo isn't needed. We don't need a PTY.
+        session.exec(opts[:command]) 
+      end
+
+      # go time... for real.
+      session.loop
+    end
+  end
+end

data/lib/fissher_conf.rb

@@ -0,0 +1,165 @@
+
+#############################################
+#  Option/config parsing for Fissher        #
+#############################################
+
+require 'json'
+require 'highline/import'
+require 'getopt/std'
+
+module FissherConf
+  class Misc
+    def getpass(prompt="Enter remote password: ")
+      ask(prompt) {|q| q.echo = false}
+    end
+
+    # Method for returning hosts from hostgroup.
+    def group_hosts( grp,conf,conf_file )
+      if conf[:hostgroups][:"#{grp}"] 
+        conf[:hostgroups][:"#{grp}"][:hosts]
+      else
+        abort "Fatal: hostgroup #{grp} not defined in #{conf_file}!\n"
+      end
+    end
+  end
+
+  def usage
+    puts "#{$0} [flags] [command]:\n"
+    puts "-G Hostgroup       Execute command on all hosts listed in the JSON config for the\n"
+    puts "                   specified group.\n"
+    puts "-H Host1,Host2     Execute command on hosts listed on the command line\n"
+    puts "-g jumpbox         Manually specify/override a jump server, if necessary.\n"
+    puts "-s 		     Execute the provided commands with sudo."
+    puts "-u username        Manually specify/override username to connect with.\n"
+    puts "-p                 Use password based authentication, specified via STDIN\n"
+    puts "-c config.json     Manually specify the path to your fissher config file\n"
+    puts "-n num             Number of concurrent connections. Enter 0 for unlimited.\n"
+    puts "-U username	     Specify an alternate user in conjunction with -s (E.G. -U webmaster)\n"
+  end
+
+  def die( msg )
+    puts "#{msg}\n"
+    usage
+    exit 1
+  end
+
+  def handle_opts
+    opt = Getopt::Std.getopts("pc:g:G:u:n:sH:hU:")
+    ret = Hash.new
+
+    if opt["h"]
+      usage
+      exit 1
+    end
+ 
+    # Import configuration, either from default or a custom JSON config
+    if opt["c"]
+      conf_file = opt["c"]
+    elsif File.exists?("#{Dir.home}/.fissherrc")
+      conf_file = "#{Dir.home}/.fissherrc"
+    elsif File.exists?("/etc/fissher/fissher.conf")
+      conf_file = "/etc/fissher/fissher.conf"
+    else
+      conf_file = File.dirname(__FILE__)  + "/../etc/fissher.conf"
+    end
+    
+    # Ensure the file exists
+    begin 
+      config = JSON.parse(File.read(conf_file),:symbolize_names => true)
+    rescue
+
+      etcloc = File.dirname(__FILE__).to_s.gsub(/\/lib$/, '/etc')
+      puts <<EOB
+  ****    It appears that you have not yet created your config file!    ****
+  You can do this by copying the sample config to one of the following
+  locations:
+
+  ~/.fissherrc
+  /etc/fissher/fissher.conf
+  #{etcloc}/fissher.conf
+
+  You can find a copy of the sample in the following location:
+
+  #{etcloc}
+
+  A script will be included in the next release that will generate the file
+  for you if it does not already exist.
+EOB
+      abort
+    end
+    
+    # Use sudo for our command
+    if opt["s"]
+      if opt["U"]
+        sudo_cmd = "sudo -u #{opt['U']}"
+      else
+        sudo_cmd = "sudo"
+      end
+    end
+
+    # Gateway if an edgeserver is present
+    if opt["g"]
+      ret[:gateway] = opt["g"]
+    elsif opt["G"] && !config[:hostgroups][:"#{opt['G']}"][:gateway].nil?
+      ret[:gateway] = config[:hostgroups][:"#{opt['G']}"][:gateway]
+    elsif !config[:default_gateway].nil?
+      ret[:gateway] = config[:default_gateway]
+    end  
+
+    # Hostgroup used for batch jobs
+    if opt["G"]
+      abort "You may only specify one of -G or -H!\n" unless opt["H"].nil?
+      h = Misc.new
+      ret[:hostlist] = h.group_hosts(opt["G"],config,conf_file) 
+    end
+
+    # Username used by connections
+    if opt["u"]
+      ret[:user] = opt['u']
+    elsif config[:user]
+      ret[:user] = config[:user]
+    end
+  
+    # Job Concurrency limit
+    if opt["n"] == '0'
+      ret[:concurrency] = nil
+    elsif opt["n"]
+      ret[:concurrency] = opt["n"].to_i
+    elsif config[:concurrency]
+      ret[:concurrency] = config[:concurrency].to_i
+    else
+      ret[:concurrency] = 10
+    end
+
+    # Host list
+    if opt["H"]
+      abort "You may only specify one of -G or -H!\n" unless opt["G"].nil?
+      if opt["H"] =~ /,/
+        ret[:hostlist] = opt["H"].split(",")
+      else
+        ret[:hostlist] = [ opt["H"] ]
+      end
+    end
+
+    # Get our account password
+    if opt["p"]
+      p = Misc.new
+      ret[:password] = p.getpass()
+    else
+      ret[:password] = nil
+    end
+    
+    # Our command
+    if ARGV.count >= 1
+      if sudo_cmd
+        ret[:command] = "#{sudo_cmd} " + ARGV.join(' ').to_s
+      else
+        ret[:command] = ARGV.join(' ').to_s 
+      end
+    else
+      die "No command specified!\n" unless !ret[:command].nil?
+    end
+    ret
+  end
+end
+

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: fissher
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Jeff Hagadorn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-ssh-multi
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: getopt
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A utility written to perform batch commands on many servers over SSH.
+  Supports jump servers and hostgroups via a JSON config file.
+email: jeff@aletheia.io
+executables:
+- fissher
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/fissher_conf.rb
+- lib/fissher_base.rb
+- etc/fissher.conf.sample
+- README.rdoc
+- bin/fissher
+homepage: http://github.com/dahui/fissher
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Fissher
+test_files: []