ecl 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9dbfb94853aaa48d41c193a65a592b78f3e19fff
-  data.tar.gz: f4c864a0e4d24fe98f31f3b8d55e8afb7c499753
+  metadata.gz: bd0af5acd07853220020290c73b35f7bbc773a1b
+  data.tar.gz: 5a4dbfbf94ee66e3f1902eb966b348921fa5c459
 SHA512:
-  metadata.gz: 9bf087e07c4040d1e73343356ea050b431cdb04552c07b16d8a71b3a06dca668356868d3346cc90d5c70dbffea1a124ebf7fa16aea1fe013e7803157c2afe198
-  data.tar.gz: 8295911d2e74b3256364a3d5ed0cff8ff61052f2e4e9c439ca764ea67c104523e810cbd52f24039b5620eceb6c3f861865e8aa0e65669c60b1f32ba1e5bfe16b
+  metadata.gz: 924ffb85cc063b48ae5bc179fe4f3e41fe56dc252ca998e85aa8a52c4c2ed03384002b68112c9dbe1cc2dd8e20ac265f9eecab5b24e3a8022258f8b4707d13b0
+  data.tar.gz: 547ba1905a506123dc861c61d93ebbd6adff9251878fd5e0776db61bde472313fac60cffeb3a7d11aa27bdb7c18936ed8eb9a5e1d40a2b6e836011a195d2e6c6

data/README.md

@@ -5,15 +5,109 @@ Simple ssh helper for Amazon EC2
 ## Requirements
     
     tmux
+    ~/.aws/credentials (created by AWS CLI)
 
 ## Installation
 
-    $ gem install eclair2
+    $ gem install ecl
 
 ## Usage
 
     $ ecl
 
+First execution will create ~/.eclrc file. Edit this file and run again.
+
+## Configurations
+
+### aws_region
+
+AWS region to connect.
+
+	config.aws_region = "ap-northeast-1"
+
+### columns
+
+Max number of columns displayed in eclair.
+
+	$ config.columns = 4
+
+### ssh_username 
+
+Function to find username from image.  
+Returns username of given image.  
+Uses image data from [EC2::Client#describe_images](https://docs.aws.amazon.com/AWSRubySDK/latest/AWS/EC2/Client.html#describe_images-instance_method) API call
+
+	config.ssh_username = lambda do |image|
+	  case image.name
+	  when /ubuntu/
+	    "ubuntu"
+	  else
+	    "ec2-user"
+	  end
+	end
+
+### group_by
+
+Function to find group name from instance.  
+Returns group name from instance data.
+Uses instance data from [EC2::Client#describe_instances](https://docs.aws.amazon.com/AWSRubySDK/latest/AWS/EC2/Client.html#describe_instances-instance_method) API call.
+
+Example)  
+Group by security groups.  
+
+	config.group_by = lambda do |instance|
+	  if instance.security_groups.first
+	    instance.security_groups.first.group_name
+	  else
+	    "no_group"
+	  end
+	end
+
+Group by instance name.
+
+	config.group_by = lambda do |instance|
+	  nametag = instance.tags.find{|t| t.key == "Name"}
+	  return "Noname" unless nametag
+	  case nametag.value
+	  when /^production/
+	    "production servers"
+	  when /^test/
+	    "test servers"
+	  end
+	end
+
+Do not group instances.
+	
+	config.group_by = nil
+
+
+### ssh_ports
+Port numbers to try ssh.  
+
+	config.ssh_ports = [1234, 22]
+
+
+### ssh_options
+Extra options passed to ssh.
+
+	config.ssh_options = "-o ConnectTimeout=1 -o StrictHostKeyChecking=no"
+
+### ssh_hostname
+Hostname to use in ssh.  
+Choose from :public_dns_name, :public_ip_address, :private_dns_name, :private_ip_address
+	
+	config.ssh_hostname = :public_ip_address
+
+
+### ssh_keys
+Hash of EC2 keypair name => key_path in local.
+If your key has been already registered in ssh-agent, you don't have to configure this.
+
+  config.ssh_keys = {
+    "keypair1" => "/path/to/key1",
+    "keypair2" => "/path/to/key2",
+  }
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/eclair/config.rb

@@ -21,6 +21,7 @@ module Eclair
           "ec2-user"
         end
       end
+      @ssh_keys             = {}
       @ssh_hostname         = :public_ip_address
       @ssh_ports            = [22].freeze
       @ssh_options          = "-o ConnectTimeout=1 -o StrictHostKeyChecking=no".freeze

data/lib/eclair/instance.rb

@@ -71,9 +71,17 @@ module Eclair
       config.ssh_username.call(image(force: true))
     end
 
+    def key_cmd
+      if config.ssh_keys[key_name]
+        "-i #{config.ssh_keys[key_name]}"
+      else
+        ""
+      end
+    end
+
     def ssh_cmd
       cmd = config.ssh_ports.map{ |port|
-        "ssh #{config.ssh_options} -p#{port} #{username}@#{hostname}"
+        "ssh #{config.ssh_options} -p#{port} #{key_cmd} #{username}@#{hostname}"
       }.join(" || ")
 
       "echo Attaching to #{name}: #{username}@#{hostname} && (#{cmd})"

data/lib/eclair/version.rb

@@ -1,3 +1,3 @@
 module Eclair
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/templates/eclrc.template

@@ -1,13 +1,13 @@
 Eclair.configure do |config|
-  # aws_region - region to connect aws.
+  # aws_region - AWS region to connect.
   # This overrides AWS_REGION environment variable, so you can comment out this line if you set this in environment variable.
   config.aws_region = "ap-northeast-1"
 
-  # columns - Number of columns in eclair.
+  # columns - Max number of columns displayed in eclair.
   config.columns = 4
 
   # ssh_username - Function to find username from image
-  # You can access response data extracted from EC2::Client#describe_images API call
+  # You can use image data from EC2::Client#describe_images API call
   # https://docs.aws.amazon.com/AWSRubySDK/latest/AWS/EC2/Client.html#describe_images-instance_method
   config.ssh_username = lambda do |image|
     case image.name
@@ -18,10 +18,15 @@ Eclair.configure do |config|
     end
   end
 
-  # group_by - Function to determine group from instance
+  # ssh_keys - Hash of key_name => key_path in local.
+  # If your key has been already registered in ssh-agent, you don't have to configure this.
+  config.ssh_keys = {
+  }
+
+  # group_by - Function to find group name from instance.
   # Make a function that returns group name from instance data
-  # You can access response data extracted from EC2::Client#describe_images API call
-  # https://docs.aws.amazon.com/AWSRubySDK/latest/AWS/EC2/Client.html#describe_images-instance_method
+  # You can access response data extracted from EC2::Client#describe_instances API call
+  # https://docs.aws.amazon.com/AWSRubySDK/latest/AWS/EC2/Client.html#describe_instances-instance_method
 
   # If you want to group instances by security group, uncomment example below. (default option)
   # config.group_by = lambda do |instance|
@@ -51,7 +56,7 @@ Eclair.configure do |config|
   # Eclair will try to ssh specified ports in order with ConnectTimeout below.
   config.ssh_ports = [22]
 
-  # ssh_options - Options passed to ssh.
+  # ssh_options - Extra options passed to ssh.
   # ConnectTimeout should exist when you want to connect to multiple ports.
   config.ssh_options = "-o ConnectTimeout=1 -o StrictHostKeyChecking=no"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecl
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Devsisters
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-14 00:00:00.000000000 Z
+date: 2015-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler