ispunity 0.0.4 → 0.0.5

data/README

@@ -40,7 +40,6 @@ install the additional dependencies as mentioned.
 
 7. Usage
   ispunity clear_rules  # Clear the rules setup by the routing policy
-  ispunity configfile   # Uses the config file provided/passed to the application
   ispunity help [TASK]  # Describe available tasks or one specific task
   ispunity license      # Displays the license
   ispunity monitor      # Start monitoring the isp connections.
@@ -48,4 +47,14 @@ install the additional dependencies as mentioned.
   ispunity version      # Displays the version of Ispunity
 
       
-
+8. Starting with Ispunity
+   - Follow the following process after successful installation of ispunity
+    
+    i.  ispunity setup       : This will setup your load balancing using the ispunity configuration file.
+        Whenever you will change the configuration file, you need to run this command to take effect.
+    
+    ii. ispunity monitor     : This will check for the availability of isp connections. If any connection any network connection is down then it will load balance the network traffic on available connections.
+ 
+
+Note : We recommend to add cron job for checking the available network connections. Add following into the crontab : 
+    */5 * * * * bash -c 'source /etc/profile.d/rvm.sh && /usr/bin/env ruby /usr/local/rvm/gems/ruby-1.9.3-p125/bin/ispunity monitor'

data/bin/ispunity

@@ -2,6 +2,7 @@
 $LOAD_PATH << File.join(File.dirname(__FILE__),'..','lib')
 require 'thor'
 require 'isp_unity'
+require 'fileutils'
 
 class Ispunity < Thor
 
@@ -12,16 +13,16 @@ class Ispunity < Thor
 
   desc "setup","Setup the application"
   def setup
-    puts "Starting the setup application"
+#    puts "Starting the setup application"
     IspUnity.setup
   end
 
   desc "monitor","Start monitoring the isp connections."
   def monitor
-    puts "Starting to monitor the application"
+#    puts "Starting to monitor the application"
     IspUnity.monitor
   end
-
+=begin
   desc "configfile","Uses the config file provided/passed to the application"
   method_option :configfile, :aliases => "-c", :desc => "Config file"
   def configfile(file)
@@ -32,14 +33,27 @@ class Ispunity < Thor
   def clear_rules
     puts 'Clearing the rules.'
   end
-
+=end
   desc "license","Displays the license"
   def license
-    File.open("../license",'r') do |f|
+    File.open("license",'r') do |f|
       puts f.readlines
     end
   end
 
+  desc "copy", "Copies configuration.json.example file under /etc directory as ispunity.json"
+  def copy
+   puts "\t Configuration.json.example file copied under /etc directory as ispunity.json \n"
+   FileUtils.cp(File.join([File.expand_path(File.dirname(__FILE__)), '..', 'config', 'configuration.json.example']), File.join("/etc"))
+   File.rename(File.join('/etc', 'configuration.json.example'), File.join('/etc', 'ispunity.json'))
+  end
+
+  desc "cron", "Displays entry for cron tab"
+  def cron
+   path = `/usr/bin/which ispunity`.chomp
+   puts "#Add following line to your crontab to monitor your ISP's for every 5 minutes"
+   puts "*/5 * * * * bash -c 'source /etc/profile.d/rvm.sh && /usr/bin/env ruby #{path} monitor"
+  end
 end
 
 Ispunity.start

data/config/configuration.json.example

@@ -1,23 +1,23 @@
 {
- "no_of_isp":3,
- "status":"balancing",
- "interval":300,
  "public_dns":["8.8.8.8","8.8.4.4","4.2.2.2","4.2.2.1"],
  "log_level":1,
  "isp": [
 	   {	
-	   	"id":"isp1",
 		"name":"tata",
 		"interface":"eth0",
-		"gateway":"61.17.193.1",
+		"gateway":"192.168.3.6",
 		"subnet":"255.255.255.0",
 		"network":"61.17.193.0/24",
 		"weight":1,
 		"enabled":"true",
 		"online":"true"
+        "protocol":"tcp",
+        "port":"80",
+        "network_ip":"",
+        "skip_sticky_session":true,
+        "priority":1
 	   },
  	   {    
-	   	"id":"isp2",
 		"name":"ttml",
 		"interface":"eth2",
 		"gateway":"192.168.0.2",
@@ -26,9 +26,13 @@
 		"weight":1,
 		"enabled":"true",
 		"online":"true"
+        "protocol":"tcp",
+        "port":"80",
+        "network_ip":"",
+        "skip_sticky_session":true,
+        "priority":1
 	   },
  	   {
-	        "id":"isp3",
 		"name":"bsnl",
 		"interface":"wlan0",
 		"gateway":"192.168.2.1",
@@ -37,6 +41,14 @@
 		"weight":1,
 		"enabled":"false",
 		"online":"true"
+        "protocol":"tcp",
+        "port":"80",
+        "network_ip":"",
+        "skip_sticky_session":true,
+        "priority":1
+
 	   }
-	]
+	],
+ "skip_sticky_session":false,
+ "priority_for_sticky":"tata,ttml"
 }

data/doc/algorithm.txt

@@ -31,3 +31,21 @@ dev eth0 weight 1  nexthop via "ip gateway" dev "interface name" weight "weighta
       ip route flush table cache
    # If there is only one ISP 
       ip route replace default via "ip gateway" dev "interface name"
+
+Commands for Sticky Session:
+
+1) iptables -t mangle -A PREROUTING -s #{source network} -p #{protocol} --dport #{dport} -j MARK --set-mark #{dport}
+
+   mangle         : Table will be used for packet aleternation
+   PREROUTING     : altering  outgoing  packets before routing
+   source_network : To which network should we need to run the sticky session
+   protocol       : sticky protocols or non-sticky protocols (either TCP or UDP)
+   dport          : Destination port (on which destination port that sticky session is working) and we have mark the packet with some                     value(prefer to use to use dport value as they would be unique)
+   
+2) ip rule add fwmark #{port} lookup #{table_name}
+
+   Depends on port value it tells which ISP will need to lookup 
+
+3) ip rule del fwmark #{port} lookup #{table_name}
+
+  Deletes the rule. After delete the rule we have to add the rule again.

data/isp_unity.gemspec

@@ -5,7 +5,7 @@ require "isp_unity/version"
 
 Gem::Specification.new do |s|
   s.name        = "ispunity"
-  s.version     = IspUnity::VERSION 
+  s.version     = IspUnity::VERSION
   s.authors     = ["Pratik Shah", "Siva Gollapalli", "Arun Tomar"]
   s.email       = ["pratik14shah@gmail.com", "sivagollapalli@yahoo.com", "arun@solutionenterprises.co.in"]
   s.homepage    = "http://www.ispunity.com"
@@ -15,7 +15,8 @@ Gem::Specification.new do |s|
   s.add_dependency("i18n")
   s.add_dependency("json")
   s.add_dependency("thor")
-
+  # rspec dependency are added
+  s.add_dependency("rspec")
 
   s.rubyforge_project = "ispunity"
 

data/ispunity.sh

@@ -0,0 +1,53 @@
+#!/usr/bin/env bash
+#------------------------------------------------------------------------------------------
+# Author        : Swati A. Rananaware
+# Date          : 30-04-2012
+# Purpose       : Install Ispunity gem.
+# Description   : Install rvm and then ruby 1.9.3. Finally install Ispunity gem. 
+# For		: Ispunity
+#------------------------------------------------------------------------------------------
+
+CYAN="\033[0;36m"
+GREEN="\033[1;34m"
+NOCOLOR="\033[0m"
+
+echo -en "$CYAN Please run this script as root user so that all dependencies will be installed through script$NOCOLOR\n\n"
+
+if [ -f /etc/redhat-release ]
+then
+  yum install -y gcc-c++ patch readline readline-devel zlib zlib-devel libyaml-devel libffi-devel openssl-devel make bzip2 autoconf automake libtool bison iconv-devel
+else
+  apt-get install build-essential openssl libreadline6 libreadline6-dev curl git-core zlib1g zlib1g-dev libssl-dev libyaml-dev libsqlite3-dev sqlite3 libxml2-dev libxslt-dev autoconf libc6-dev ncurses-dev automake libtool bison subversion
+fi
+
+if [ "$1" != "--without-rvm" ]
+then
+  echo -en "\n$CYAN Gem Ispunity requires ruby 1.9.3.\
+	\n By default, this script will install RVM with ruby 1.9.3\
+	\n If you have ruby 1.9.3 installed, you can chose to install gem ispunity directly.\
+	\n Using $GREEN./ispunity --without-rvm$NOCOLUR $CYAN or Say no for rvm installation below $NOCOLOR\n\n"
+  read -p "Do you want to continue to install rvm ?? (y|n) : " ch
+case $ch in
+  'y'|'Y')
+	# Install RVM	
+	echo -en "\n\n$CYAN Installing rvm.........$NOCOLOR\n\n"
+	curl -L get.rvm.io | bash -s stable
+	source /etc/profile.d/rvm.sh
+	#Install ruby 1.9.3
+	rvm install 1.9.3-p125
+	rvm use 1.9.3-p125;;
+
+  'n'|'N')
+	;;
+  *)
+	echo -en "\n\n$CYAN Wrong Option. Should be 'y' or 'n'"
+	echo -en " Exiting the scipt execution$NOCOLOR\n"
+	exit;;
+esac
+fi
+
+echo -en "\n\n$CYAN Installing ispunity $NOCOLOR\n\n"
+
+# Install gem ispunity
+gem install ispunity
+

data/lib/isp_unity.rb

@@ -2,6 +2,7 @@ $LOAD_PATH <<  File.expand_path(File.dirname(__FILE__))
 require 'json'
 require 'yaml'
 require 'isp_unity_log'
+require 'sticky_session'
 require 'route/route'
 require 'load_balance/load_balance'
 require 'system_call'
@@ -38,33 +39,51 @@ module IspUnity
       IspUnityLog.debug("Route Command: #{route_command}")
       if SystemCall.execute(route_command)
         IspUnityLog.info(I18n.t('system_call.execute.route.success'))
+
+        #RULE COMMAND
         Rule.build_commands(isp_lists)
-	rule_command = Rule.commands
+        rule_command = Rule.commands
         IspUnityLog.info(I18n.t('rule.build_commands'))
-      	IspUnityLog.debug("Rule Command: #{rule_command}")
+        IspUnityLog.debug("Rule Command: #{rule_command}")
         SystemCall.execute(rule_command)
         IspUnityLog.info(I18n.t('system_call.execute.rule.success'))
+
+        #LOAD BALANCE
         LoadBalance.build_commands(isp_lists)
-	load_balance_command = LoadBalance.commands
+        load_balance_command = LoadBalance.commands
         IspUnityLog.info(I18n.t('load_balance.build_commands'))
-      	IspUnityLog.debug("Load Balance Command: #{load_balance_command}")
+        IspUnityLog.debug("Load Balance Command: #{load_balance_command}")
         SystemCall.execute(load_balance_command)
         IspUnityLog.info(I18n.t('system_call.execute.load_balance.success'))
+
+        #Sticky Session
+        StickySession.execute(isp_lists) if $skip_sticky_session
       end
     end
 
     def monitor
       IspUnity.config
-      new_list = []
+      online_isps = []
       IspUnity.isp_config_list.each do |isp|
-        new_list << isp  if LoadBalance.is_alive(isp) 
+        online_isps << isp  if LoadBalance.is_alive(isp) 
       end
-      unless  new_list == isp_config_list
+
+      #Failover case
+      unless  online_isps == isp_config_list
+
+        #LOAD BALANCE
         LoadBalance.build_commands(IspUnity.isp_config_list)
         IspUnityLog.info(I18n.t('load_balance.build_commands'))
         SystemCall.execute(LoadBalance.commands)
         IspUnityLog.info(I18n.t('system_call.execute.load_balance.success'))
-        SystemCall.execute('ip route flush cache')
+
+        #Flush route
+        SystemCall.execute('/sbin/ip route flush cache')
+
+        #Change sticky session 
+        offline_isps = isp_lists - online_isps
+        StickySession.change_rule(offline_isps, online_isps)
+  
       end
     end
   end

data/lib/isp_unity/isp.rb

@@ -1,18 +1,21 @@
 class Isp
 
-  attr_accessor :id, :name, :interface, :gateway, :subnet, :network, :online, :enabled, :ip_address, :weight
+  attr_accessor :name, :interface, :gateway, :subnet, :network, :online, :enabled, :ip_address, :weight, :protocol, :port, :network_ip, :priority
   
   def initialize(config_isp)
-    @id = config_isp['id']
-    @name = config_isp['name']
-    @interface = config_isp['interface']
-    @gateway = config_isp['gateway']
-    @subnet = config_isp['subnet']
-    @network = config_isp['network']
-    @online = config_isp["online"]
-    @enabled = config_isp['enabled']
+    @name       = config_isp['name']
+    @interface  = config_isp['interface']
+    @gateway    = config_isp['gateway']
+    @subnet     = config_isp['subnet']
+    @network    = config_isp['network']
+    @online     = config_isp["online"]
+    @enabled    = config_isp['enabled']
     @ip_address = config_isp['ip_address']
-    @weight = config_isp['weight']
+    @weight     = config_isp['weight']
+    @protocol   = config_isp['protocol']
+    @port       = config_isp['port']
+    @network_ip = config_isp['network_ip']
+    @priority   = config_isp['priority']
   end
 
 end

data/lib/isp_unity/routing_table.rb

@@ -10,56 +10,61 @@ module IspUnity
     attr_reader :isp_config_list
 
     def config
-      begin
-        configurations = JSON.parse(File.read(ConfigFilePath))   
-        IspUnityLog.info(I18n.t('file.read.success'))
-      rescue Exception => e
-        IspUnityLog.debug("#{e}")
-        IspUnityLog.error(I18n.t('file.read.error'))
-        raise IspUnityException.new(I18n.t('file.read.error'))
-      end
+      # If file is exists then it reads that otherwise log an error 
+      if File.exist?(ConfigFilePath)
+        begin
+          configurations = JSON.parse(File.read(ConfigFilePath))   
+          IspUnityLog.info(I18n.t('file.read.success'))
+        rescue Exception => e
+          IspUnityLog.debug("#{e}")
+          IspUnityLog.error(I18n.t('file.read.error'))
+          raise IspUnityException.new(I18n.t('file.read.error'))
+        end
 
-      @isp_config_list = [] 
-      no_of_isp = configurations['no_of_isp']
-      isp_list = configurations['isp']
-      $ip_cluster = configurations['public_dns']
+        @isp_config_list = [] 
+        isp_list = configurations['isp']
+        $ip_cluster = configurations['public_dns']
+        $skip_sticky_session = configurations['skip_sticky_session']
+        $priority_for_sticky = configurations['priority_for_sticky'].split(',') if configurations['priority_for_sticky']
 
-      if no_of_isp
-        isp_list.each do|data|
-	  if data['enabled'] == 'true'
-            ip_addr = SystemCall.get_ip(data['interface'].to_s)
-            if ip_addr
-              data['ip_address'] = SystemCall.get_ip(data['interface'])
-              @isp_config_list.push(Isp.new(data)) 
-            else
-              puts I18n.t('no_ip_addr') + data['name']
-              IspUnityLog.error(I18n.t('no_ip_addr') + data['name'] )
+        if isp_list 
+          isp_list.each do|data|
+            if data['enabled'] == 'true'
+              ip_addr = SystemCall.get_ip(data['interface'].to_s)
+              if ip_addr
+                data['ip_address'] = SystemCall.get_ip(data['interface'])
+                @isp_config_list.push(Isp.new(data)) 
+              else
+                puts I18n.t('no_ip_addr') + data['name']
+                IspUnityLog.error(I18n.t('no_ip_addr') + data['name'] )
+              end
             end
           end
+          IspUnityLog.info('Isp Object succesfully created!')
+        else
+          raise IspUnityException.new(I18n.t('file.enter_isp'))
+          IspUnityLog.error(I18n.t('file.read.no_isp_found'))
         end
-        IspUnityLog.info('Isp Object succesfully created!')
-      else
-        raise IspUnityException.new(I18n.t('file.enter_isp'))
-        IspUnityLog.error(I18n.t('file.read.no_isp_found'))
-      end
-
 
-      routing_table = File.read(RoutingTablePath)
-      IspUnityLog.info(I18n.t('routing_table.read.success'))
-      begin
-        @isp_config_list.each do|isp_list|
-          unless routing_table.include?(isp_list.name)
-            File.open(RoutingTablePath, 'a') {|f| f.write("#{rand(100)}  #{isp_list.name} \n")}
+        routing_table = File.read(RoutingTablePath)
+        IspUnityLog.info(I18n.t('routing_table.read.success'))
+        begin
+          @isp_config_list.each do|isp_list|
+            unless routing_table.include?(isp_list.name)
+              File.open(RoutingTablePath, 'a') {|f| f.write("#{rand(100)}  #{isp_list.name} \n")}
+            end
+            IspUnityLog.info(I18n.t('isp.created'))
           end
-          IspUnityLog.info(I18n.t('isp.created'))
+        rescue Exception => e
+          IspUnityLog.debug("#{e}")
+          IspUnityLog.error(I18n.t('routing_table.read.error'))
+          raise IspUnityException.new(I18n.t('routing_table.read.error'))
         end
-      rescue Exception => e
-        IspUnityLog.debug("#{e}")
-        IspUnityLog.error(I18n.t('routing_table.read.error'))
-        raise IspUnityException.new(I18n.t('routing_table.read.error'))
+      else
+        @isp_config_list = []
+        puts "Please make ensure that configuration file has copied on /etc dir"
+        IspUnityLog.error('Please make ensure that configuration file has copied on /etc dir')
       end
-
     end
   end
 end
-

data/lib/isp_unity/version.rb

@@ -1,3 +1,3 @@
 module IspUnity
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/load_balance/load_balance.rb

@@ -33,11 +33,12 @@ class LoadBalance
       result = `/bin/ping -c 3 -I #{isp.ip_address} #{$ip_cluster.sample}`
       if result.match("100% packet loss")
            IspUnityLog.info("100% packet loss for #{isp.name}")
-          return false
+           isp.online = false
       else
           IspUnityLog.info("0% packet loss for #{isp.name}")
-          return true
+          isp.online = true
       end
+      return isp.online 
     end
 
   end

data/lib/sticky_session.rb

@@ -0,0 +1,39 @@
+class StickySession 
+  
+  class << self
+
+    def execute(isps=[])
+      isps.each do |isp|
+        if isp.skip_sticky_session
+          # Mark the outgoing packet with port value
+          command = "iptables -t mangle -A PREROUTING -s #{isp.network_ip} -p #{isp.protocol} --dport #{isp.dport} -j MARK --set-mark #{isp.dport}"
+          SystemCall.execute(command)
+          # Lookup the ISP depends on marked value 
+          command = "ip rule add fwmark #{isp.port} lookup #{isp.name}"
+          SystemCall.execute(command)
+        end
+      end
+    end
+
+    def change_rule(offline_isps=[], online_isps=[])
+      #online_isps consist of online isps
+      online_isps.sort! { |a,b| a.priority  <=> b.priority }
+    
+     # Remove rule of failed(offline) isp
+      offline_isps.each do |isp|
+        if isp.skip_sticky_session
+          command = "ip rule del fwmark #{isp.port} lookup #{isp.name}"
+        end
+      end
+
+      # Add new rule to online isp with high priority
+      offline_isps.each do |isp|
+        if isp.skip_sticky_session
+          command = "ip rule add fwmark #{isp.port} lookup #{online_isps[0].name}"
+        end
+      end
+
+    end
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ispunity
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-01 00:00:00.000000000 Z
+date: 2012-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: log4r
@@ -77,6 +77,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: With IspUnity, you can 1.Use multiple internet connections simultaneously
   and get all their throughput. 2.Automatic failover on working net connection if
   any on of the internet connection goes down.
@@ -100,6 +116,7 @@ files:
 - config/settings.yml
 - doc/algorithm.txt
 - isp_unity.gemspec
+- ispunity.sh
 - lib/isp_unity.rb
 - lib/isp_unity/isp.rb
 - lib/isp_unity/routing_table.rb
@@ -108,6 +125,7 @@ files:
 - lib/load_balance/load_balance.rb
 - lib/route/route.rb
 - lib/rule/rule.rb
+- lib/sticky_session.rb
 - lib/system_call.rb
 - license
 - log/isp_unity.log