awssh 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41ff945d54ed3800f4453bcde333df76f1ddf186
-  data.tar.gz: c05e3208e7953cdebf07f47e812f78f7e9357fe3
+  metadata.gz: 34f90f8db1821a009c13349a1a086a96e5200c2b
+  data.tar.gz: 49a74acf53fe5c80bfaa7baebe961887a6cf32a6
 SHA512:
-  metadata.gz: 2219334008fdc31fe8e702818d28b2e09ac12f9eab7a63b0d438bc24d3a4361cfaeefb7d3284de0b6d32138920f13ecf1217b86410cd21854c49cbc4e7c7a8c9
-  data.tar.gz: a77c02a299a80abf29952e22f1d6906a025075a9e5fbe9b33307806d4f5dc3a48795c3a1a9275e09a6bfaea0ee153d359905be344d4bebbbad8f34332713aa8b
+  metadata.gz: 366decc391cad6e35c85976ab31cabf97d6c15f4470e6d6f4ee72d3c43ed00380c26c471dde71a3a7727e9b17a7a5af505f40b0c6de87c7183efbcd1063c814b
+  data.tar.gz: fba8f18db93c5e602a6960f436ec466fe0c0645238e23132be683dec7049408065494e2a67d2d19149f07d17489c845876cf73389dd8a53238cf198bb2b7c656

data/README.md

@@ -17,9 +17,10 @@ Initialize the config file:
 
     $ awssh -i
 
-Edit the config file and add the AWS key and secret.
+Edit the config file and add the AWS region, key, and secret.
 ```
 ...
+region: us-east-1              # AWS region
 key: AWS ACCESS KEY ID         # AWS key
 secret: AWS SECRET ACCESS KEY  # AWS secret
 ...
@@ -27,12 +28,21 @@ secret: AWS SECRET ACCESS KEY  # AWS secret
 
 ## Requirement
 
-The only requirement of the tool is that the Name tag on the instance maps to the DNS record.
+### Use Names = False
+
+With `use_names: false` in the config, the tool will use the private address of the 
+server, expecting that the servers are in a vpc and that you are able to connect
+to them directly (with VPN).
+
+### Use Names = True
+
+If `use_names: true`, then the only requirement of the tool is that the Name tag 
+on the instance maps to the DNS record.
 Generally, `awssh` expects that if the name of the instance is `foo.bar`, then it can
 connect to the server by appending the domain name as `foo.bar.example.com`.
 
 If you unset the domain name in the config, it will not append it. As such, if your Name
-tag maps directly to the DNS name, it will work as well.
+tag maps directly to the FQDN, it will work as well.
 
 In the future, I might add a templated way for handling hostnames, to allow for
 more customization in DNS lookup.
@@ -50,8 +60,10 @@ Search Terms:
     name !~ /term/
 
 Options:
+    -c, --config                     override config file (default: ~/.awssh)
     -V, --version                    print version
-    -i, --init                       initialize config
+    -i, --identity=IDENTITY          set ssh key
+        --init                       initialize config
 
     -l, --list                       just list servers
     -n, --test                       just output ssh command
@@ -61,9 +73,7 @@ Options:
         --no-cache                   disable cache for this run
 
     -m, --[no-]multi                 connect to multiple servers
-    -c, --config                     override config file (default: ~/.awssh)
-    -u, --user                       override user setting
-
+    -u, --user USER                  override user setting
 ```
 ## Examples
 Given a list of servers:
@@ -96,15 +106,20 @@ awssh -m production ^app3 #=> web1.production, web2.production, app1.production,
 ## Config
 ```
 ---
-multi: csshX                   # multi ssh program: csshX or cssh
-single: ssh                    # ssh program, allows for common configs
-region: us-east-1              # ec2 region
-user:                          # username to ssh as
-key: AWS ACCESS KEY ID         # AWS key
-secret: AWS SECRET ACCESS KEY  # AWS secret
-domain: example.com            # append domain to server names
-cache: "~/.awssh.cache"        # cache file location
-expires: 86400                 # cache expiration time (in seconds)
+region: us-east-1               # AWS Region
+key: AWS_ACCESS_KEY_ID          # AWS access key id
+secret: AWS_SECRET_ACCESS_KEY   # AWS secret access key
+multi: csshX                    # command to use when connecting to multiple servers
+single: ssh                     # command to use when connecting to single server
+#user: username                 # set user for connection to all servers
+                                # this can be overridden on the command line
+domain: example.com             # if 'use_names' is set, this will be appended
+                                # to names, leave blank if name is fully-qualified
+use_names: false                # if true, rather than connecting to IP's,
+                                # connection strings will be created using Name
+                                # tag and domain
+cache: ~/.awssh.cache           # the cache file, set to false to disable caching
+expires: 86400                  # cache expiration time in seconds
 ```
 
 ## Multi SSH
@@ -121,7 +136,6 @@ for more advanced usage.
 ## Caching
 
 Maintains a simple cache with expiration (default: 1 day).
-The cache just contains the list of servers' names.
 You can disable the cache by setting the cache value to false in the config file.
 
 ## Shell Alias

data/lib/awssh/config.rb

@@ -17,9 +17,9 @@ module Awssh
     attr_reader :data
 
     def initialize(file)
-      @file = file
-      raise "config file does not exist: #{file}" unless File.exist?(file)
-      @data = OpenStruct.new(YAML.load_file(file))
+      @file = File.expand_path(file)
+      yaml = File.exist?(@file) ? YAML.load_file(file) : {}
+      @data = OpenStruct.new(yaml)
     end
 
     DEFAULT = <<-EOF

data/lib/awssh/version.rb

@@ -2,7 +2,7 @@ module Awssh
   module Version
     MAJOR = 0
     MINOR = 3
-    TINY  = 1
+    TINY  = 2
     TAG   = nil
     LIST  = [MAJOR, MINOR, TINY, TAG].compact
     STRING = LIST.join('.')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: awssh
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Shawn Catanzarite
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-23 00:00:00.000000000 Z
+date: 2015-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk