ec2-ssh 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f7fc4d61b4b6469b8a4c7ff5f1a40cefab2782ac
-  data.tar.gz: 4cd60c018fc113b9746adfd30e52c713bd4d2a77
+  metadata.gz: 1937a7b40c0d0eca79b23921c42e33aab59f5d22
+  data.tar.gz: 89a9a42e2726cda0b87bffc40dec71d3430fff9b
 SHA512:
-  metadata.gz: 811f77f8b9dfb8e626da2b2581b12d9530cbaf7808649ae0bc727b1a4c3b9ff6a1f91bbe1120ef8be30ed8a95d9bd74cca7f8218327fd34454473ebc5159e8ce
-  data.tar.gz: 6803e2d985724957600fe947db7288bfcdc9f88414967617fe7f608c37caad6ff9e61ccdf9cac7fb831fe2f3b1b53c51166c18194ac4593187ffcc61d9f3fc16
+  metadata.gz: 10708e39a4966fa9e944775fa06ba878dd41c49250b0bfeca699d9b0d3759dfd5253d059d1610b6a67b8901b253a7fc7226709c4e69abab697c4732778e397f5
+  data.tar.gz: 4a54d77fb72beaea0d336e4e0e49c4189029d6e3b7f616acb6b9763fc86f3abf7f33bf34d687afd11edcd07a890514f4277ea02edd27a5cf5924c1a38ebbe16f

data/README.md

@@ -1,20 +1,51 @@
-This is a utility for connecting on ec2to autoscale groups and run multiple commands either parallel sequential or in groups
+````bash
+Usage:
+  ec2-ssh connect
+
+Options:
+      [--cmd=CMD]                       # commmand to run on remote servers
+      [--profile=PROFILE]               # Aws cli profile name as listed in ~/aws/credentials
+                                        # Default: default
+      [--region=REGION]                 # region
+                                        # Default: us-east-1
+  u, [--user=USER]                      # run as user
+                                        # Default: ec2-user
+  p, [--parallel=PARALLEL]              # run in parallel
+  s, [--sequence=SEQUENCE]              # run in sequence
+  g, [--groups=GROUPS]                  # run in groups
+  l, [--groups-limit=N]                 # limit
+  w, [--wait=N]                         # wait
+      [--as=AS]                         # filter by autoscale groups
+      [--tag-key=TAG_KEY]               # tag key to filter instances by
+                                        # Default: Name
+      [--tag-value=TAG_VALUE]           # tag value to filter instances by
+  t, [--terminal=TERMINAL]              # open terminal tabs for all servers
+  c, [--capture-output=CAPTURE_OUTPUT]  # capture output
+      [--upload=source,destination]     # upload a file - source,destination (make sure seperate these by comma)
+      [--download=source,destination]   # download a file - source,destination (make sure seperate these by comma)
+
+Connect to autoscale instance (random instance), Pass --cmd='whatever' to run a cmd on the server (use ; to seperate commands)
+````
+
+This is a utility for connecting on ec2 to autoscale groups and run multiple commands either parallel sequential or in groups
 
 (based on sshkit https://github.com/capistrano/sshkit)
 
 use it where you need to upload / download / capture output/ exec commands
 
-````txt
 seperate commands with a semicolon
 
+default values are:
+````txt
 default region: us-east-1
 default user: ec2-user
-default connnection :parallel
+default connnection: parallel
+default tag key: Name
 ````
 
-Groups were designed in this case to relieve problems (mass Git checkouts) where you rely on a contested resource that you don't want to DDOS by hitting it too hard.
+--groups flag was designed to relieve problems (such as mass Git checkouts) where you rely on a contested resource that you don't want to DDOS by hitting it too hard.
 
-Sequential runs were intended to be used for rolling restarts, amongst other similar use-cases.
+--sequence flag is intended to be used for rolling restarts, amongst other similar use-cases.
 
 if the instance is on a private subnet (given you have a VPN connection) it will fallback to connecting using the internal IP address
 
@@ -42,7 +73,7 @@ $ ec2-ssh --tag-value ElasticSearch --profile otherAccountName --cmd 'touch /tmp
 ````
 -------------------
 
-connect by selecting autoscale group name
+connect interactively by selecting from a list of autoscale group names
 
 ````bash
 $ ec2-ssh --as --cmd 'touch /tmp/test'
@@ -56,34 +87,3 @@ simply selct the number corresponding to the autoscale group (limit of AWS SDk i
 
 -------------------
 
-
-##Possible command line options
-````bash
-Usage:
-  ec2-ssh connect
-
-Options:
-      [--cmd=CMD]                       # commmand to run on remote servers
-      [--profile=PROFILE]               # Aws cli profile name as listed in ~/aws/credentials
-                                        # Default: default
-      [--region=REGION]                 # region
-                                        # Default: us-east-1
-  u, [--user=USER]                      # run as user
-                                        # Default: ec2-user
-  p, [--parallel=PARALLEL]              # run in parallel
-  s, [--sequence=SEQUENCE]              # run in sequence
-  g, [--groups=GROUPS]                  # run in groups
-  l, [--groups-limit=N]                 # limit
-  w, [--wait=N]                         # wait
-      [--as=AS]                         # filter by autoscale groups
-      [--tag-key=TAG_KEY]               # tag key to filter instances by
-                                        # Default: Name
-      [--tag-value=TAG_VALUE]           # tag value to filter instances by
-  t, [--terminal=TERMINAL]              # open terminal tabs for all servers
-  c, [--capture-output=CAPTURE_OUTPUT]  # capture output
-      [--upload=source,destination]     # upload a file - source,destination (make sure seperate these by comma)
-      [--download=source,destination]   # download a file - source,destination (make sure seperate these by comma)
-      [--pty=PTY]                       # enable pty for sudo operations
-
-Connect to autoscale instance (random instance), Pass --cmd='whatever' to run a cmd on the server (use ; to seperate commands)
-````

data/lib/ec2-ssh.rb

@@ -1,5 +1,5 @@
 module Ec2Ssh
-  VERSION   = "1.1.0"
+  VERSION   = "1.2.0"
   ABOUT     = "ec2-ssh v#{VERSION} (c) #{Time.now.strftime("2015-%Y")} @innovia"
 
   $:.unshift File.expand_path(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/ec2-ssh/aws.rb

@@ -7,40 +7,33 @@ module Ec2Ssh::Cli::Aws
     @as = Aws::AutoScaling::Client.new()
     @ec2 = Aws::EC2::Client.new()
 
-    say "Currently running AWS User is: #{Aws::IAM::CurrentUser.new.arn}"
+    say "Currently running user is: #{Aws::IAM::CurrentUser.new.arn}"
   end
 
-  def get_auto_scale_groups(grep_pattern)
-    say "Fetching AutoScale Groups - please wait..."
-      @as_groups = @as.describe_auto_scaling_groups({max_records: 100}).auto_scaling_groups
+  def get_auto_scale_groups
+    say "Fetching AutoScale groups from #{@region} please wait..."
+      @as_groups = @as.describe_auto_scaling_groups.auto_scaling_groups
 
       as_group_names = @as_groups.inject([]) {|acc, asg| acc << asg.auto_scaling_group_name; acc }
 
       as_selection = {}
-
-      if grep_pattern
-       as_groups =  as_group_names.grep(grep_pattern)
-      else
-        as_groups = as_group_names
-      end
-      as_groups.each_with_index.inject(as_selection) {|acc, pair|
+      as_group_names.each_with_index.inject(as_selection) {|acc, pair|
         element, index = pair
         as_selection[index] = element
         acc
-      }
-
+      } 
+      
       say "AutoScale Group in #{options[:region]}:\n"
       as_selection.each {|k,v| say "#{k}: #{v}"}
 
       selected_as = ask("Which server group do you want to ssh to?", color = :yellow)
-
+      
       get_instances('aws:autoscaling:groupName', as_selection[selected_as.to_i])
   end
 
   def get_instances(tag_key, tag_value)
     @all_servers = []
 
-    say "Fetching instances with #{tag_key}: #{tag_value}", color = :white
     response = @ec2.describe_instances({
       filters: [
       {
@@ -58,17 +51,11 @@ module Ec2Ssh::Cli::Aws
     })
 
     if !response.reservations.empty?
-      response.reservations.each {|r| r.instances.inject(@all_servers){|acc, k|
-        if k.public_ip_address.nil?
-          say "Could not find public ip address for instance: #{k.instance_id}, falling back to private ip address", color = :yellow
-          acc << k.private_ip_address; acc
-        else
-          acc << k.public_ip_address; acc
-        end
-      }}
+      response.reservations.each {|r| r.instances.inject(@all_servers){|acc, k| acc << k.public_ip_address; acc}}
     else
       say "could not find any instances with the tag #{tag_key}: #{tag_value} on #{@region}"
     end
-    say "All servers: #{@all_servers}"
+
+    say "All servers: #{@all_servers.size}"
   end
 end

data/lib/ec2-ssh/cli.rb

@@ -18,7 +18,7 @@ class Ec2Ssh::Cli  < Thor
 
   desc "connect", "Connect to autoscale instance (random instance), Pass --cmd='whatever' to run a cmd on the server (use ; to seperate commands)"
   method_option :cmd,                              :desc => 'commmand to run on remote servers'
-  method_option :profile,                          :desc => 'Aws cli profile name as listed in ~/aws/credentials', :default => 'default'
+  method_option :profile,                          :desc => 'aws cli profile', :default => 'default'
   method_option :region,                           :desc => "region", :default => 'us-east-1'
   method_option :user,            :aliases => 'u', :desc => 'run as user', :default => 'ec2-user'
   method_option :parallel,        :aliases => 'p', :desc => 'run in parallel'
@@ -26,32 +26,24 @@ class Ec2Ssh::Cli  < Thor
   method_option :groups,          :aliases => 'g', :desc => 'run in groups'
   method_option :groups_limit,    :aliases => 'l', :desc => 'limit', :type => :numeric
   method_option :wait,            :aliases => 'w', :desc => 'wait',  :type => :numeric
-  method_option :as,                               :desc => 'filter by autoscale groups'
-  method_option :grep,                             :desc => 'grep autoscale name when list is fecthed'
+  method_option :as,                               :desc => 'display interactive choices for autoscale groups'
   method_option :tag_key,                          :desc => 'tag key to filter instances by', :default => 'Name'
   method_option :tag_value,                        :desc => 'tag value to filter instances by'
   method_option :terminal,        :aliases => 't', :desc => 'open terminal tabs for all servers'
-  method_option :capture_output,  :aliases => 'c', :desc => 'capture output'
-  method_option :upload,                           :desc => 'upload a file - source,destination (make sure seperate these by comma)', :banner => 'source,destination'
-  method_option :download,                         :desc => 'download a file - source,destination (make sure seperate these by comma)', :banner => 'source,destination'
-  method_option :pty,                              :desc => 'enable pty for sudo operations', :type => :boolean, :default => false
   def connect
     extend Aws
     extend Ssh
     extend Utils
-    set_ssh(options[:user], options[:pty])
-    aws_init(options[:profile], options[:region])
 
+    set_ssh(options[:user])
+    aws_init(options[:profile], options[:region])
+      
     if options[:as]
       get_auto_scale_groups
     elsif options[:tag_value]
       get_instances(options[:tag_key].chomp, options[:tag_value].chomp)
-    else
-      say "No value provided for filtering instances", color = :red
-      Ec2Ssh::Cli.start(%w{help connect})
-      exit
     end
-
+    
     if options[:terminal]
       open_in_terminal
     else
@@ -61,18 +53,17 @@ class Ec2Ssh::Cli  < Thor
         exit 1
       end
 
-      mode = :parallel if options[:parallel]
+      mode = :parallel if options[:parallel] || mode.nil?
       mode = :groups   if options[:groups]
       mode = :sequence if options[:sequence]
 
-      mode = :parallel if mode.nil?
       dsl_options = {}
       dsl_options[:in] = mode
       dsl_options[:wait]  = options[:wait] if options[:wait]
       dsl_options[:limit] = options[:groups_limit] if options[:groups_limit]
-
-      say "dsl opts: #{dsl_options}", color = :cyan
-      ssh_to(options[:user], dsl_options, options[:cmd], options[:capture_output], options[:upload], options[:download])
+      
+      say "user: #{options[:user]}\ndsl_options: #{dsl_options}\ncmd: #{options[:cmd]}", color = :cyan
+      ssh_to(options[:user], dsl_options, options[:cmd])
     end
   end
 
@@ -80,6 +71,6 @@ class Ec2Ssh::Cli  < Thor
   desc "version", "version"
   def version
     say Ec2Ssh::ABOUT, color = :green
-  end
+  end  
 
 end

data/lib/ec2-ssh/ssh.rb

@@ -1,47 +1,23 @@
+require 'sshkit'
+require 'sshkit/dsl'
+include SSHKit::DSL
+
 module Ec2Ssh::Cli::Ssh
-  def set_ssh(user, pty)
+  def set_ssh(user)
     ENV['SSHKIT_COLOR'] = 'TRUE'
     SSHKit.config.output_verbosity = Logger::DEBUG
-    ssh_options = {
+    SSHKit::Backend::Netssh.configure { |ssh|
+      ssh.ssh_options = {
         :user => user,
         :paranoid => false,
         :forward_agent => true,
         :user_known_hosts_file => '/dev/null'
+      }
     }
-
-    SSHKit::Backend::Netssh.configure { |ssh|
-      ssh.ssh_options = ssh_options
-      ssh.pty = true if pty
-    }
-
-
   end
 
-  def ssh_to(user, dsl_options, cmd, capture_output, upload, download)
+  def ssh_to(user, dsl_options, cmd)
     say "Running #{cmd} via ssh in #{dsl_options}", color = :cyan
-    on @all_servers, dsl_options  do |host|
-     
-      if upload
-        file = upload.split(',').map { |e| e.strip }
-        source = File.expand_path(file.first)
-        destination = file.last
-        puts "uploading #{source} to #{destination}"
-        upload! source, destination
-      end
-
-      if download
-        file = download.split(',').map { |e| e.strip }
-        source = file.first
-        destination = File.expand_path(file.last)
-        puts "downloading #{source} to #{destination}.#{host}"
-        download! source, "#{destination}.#{host}"
-      end
-
-      if capture_output 
-        puts capture cmd
-      elsif upload.nil? && download.nil?
-        execute cmd
-      end
-    end
+    on(@all_servers, in: dsl_options[:in]) { |host| execute cmd }
   end
 end

data/lib/ec2-ssh/utils.rb

@@ -1,19 +1,19 @@
 module Ec2Ssh::Cli::Utils
   def open_in_terminal
     @all_servers.each do |server|
-      say "Opening #{server} in a new tab", color = :cyan
       `osascript <<-eof
-         tell application "iTerm"
-          make new terminal
-          tell the current terminal
-            activate current session
-            launch session "Default Session"
-            tell the last session
-              set name to "#{server}"
-              write text "ssh ec2-user@#{server}"
+        tell application "iTerm"
+          tell current window
+            create tab with default profile
+            tell the current tab
+              activate current session
+              tell the last session
+                set name to "#{server}"
+                write text "ssh -o StrictHostKeyChecking=no ec2-user@#{server}"
+              end tell
             end tell
           end tell
-         end tell
+        end tell
       eof`
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ec2-ssh
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Ami Mahloof
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-25 00:00:00.000000000 Z
+date: 2016-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -110,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: run commmands on multiple servers by tag or by autoscale group