lakitu 1.0.8 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8534495ff75bb0d39cf1776d24b9c6968a521c2
-  data.tar.gz: 67321425b7a18cdf41c0a445e25df7589205eb90
+  metadata.gz: e641d8d58175c49337d22b7356b804deb469ade2
+  data.tar.gz: 371330d9bd424f9dc5af130b71cc5f085348e17d
 SHA512:
-  metadata.gz: 0a8397c75b3e2bc0a788d50a8860004f6146e763b922126044365b4861db6bb676d4517567482c8b018684661ea826ac8c147065554334d4d388f5cb75dbe3d0
-  data.tar.gz: f2d9d86cf7d4519d7a586e1c57e94ae6c92937035652700b68da0d10f7ff240534319903fe2e3e43b572dfdfce181e57f9fa02f01798cd8c38f5a785b73ed15f
+  metadata.gz: 546102fd353cc2513848a2b1d2eb84ff723b98d1d1d959e162ba8d4b3412a7dd56163be79bb14c2de4aafcc63a66453742673ed6d1c329ac892028e178e941ca
+  data.tar.gz: 02b3fb23eed006859413e74f016989b36e2eddfdfb2eae12f685f8826fba386468ef8b86053f87e5abc44c6c3cf61b4d264161bb99560604d90698893891887f

data/README.md

@@ -20,6 +20,23 @@ $ lakitu configure
 $ lakitu edit
 ```
 
+## How It Works
+Lakitu parses your AWS credentials file, and for each configured profile will pull a list of Public IP addresses. It will also try look for files in `~/.ssh/` matching the keypair listed for each instance, and if it exists will add the key to the generated config output. For example, if your instance has a keypair listed on the console as `acme-production`, and you have a local file at `~/.ssh/acme-production.pem`, Lakitu will configure that key to be used when connecting to the specified instance.
+
+It's not possible for Lakitu to determine usernames or proxy commands to use when connecting to instances. To allow configuration of this and other SSH related things, lakitu looks for a `~/.ssh/local.sshconfig` file and prepends it to the generated ssh config. When first run, Lakitu will back up your old SSH config to this location. You can also edit this file via `lakitu edit`, which will then regenerate your primary config after editing.
+
+A common `local.sshconfig` might include things like the following:
+```
+Host acme-*
+  User ubuntu
+
+Host enron-*
+  ForwardAgent yes
+  ProxyCommand nohup ssh ubuntu@gateway.enron.com nc %h %p
+```
+
+Which would then be prepended to the generated global SSH config.
+
 ## Periodic Refresh
 Simply add the following line to your `.bashrc`
 ```
@@ -42,6 +59,11 @@ There are several projects that will generate an SSH config from AWS instance da
   - **Extensibility**: A simple Provider API allows easy support for new providers.
   - **Reliability**: A robust test suite ensures that Lakitu probably won't cause your machine to combust unexpectedly.
 
+## Why do you have to clobber my SSH config?
+One major goal of this project is to support `bash-completion` "out of the box". Unfortunately, most versions of SSH in use right now don't support the `Include` directive, and `bash-completion` will only look at the main ssh config. Changes have been prepared for when `Include` becomes more commonly supported which will simply add an Include directive and will put lakitu output into its own isolated file. However, this branch remains unmerged due to overwhelming lack of support for this directive.
+
+It's important to note that lakitu has several checks to prevent clobbering or destroying an unmanaged ssh config. However, once lakitu is managing the config (`# Managed by lakitu` is found in the file) it will overwrite the file ruthlessly. For this reason, you should always make custom changes via the `laktiu edit` command, or by editing `local.sshconfig`.
+
 ## Other Options
 You could also check out the folowing if this is too much hubbub for you:
   - https://rubygems.org/gems/knife-ec2-ssh-config

data/lib/lakitu/generator.rb

@@ -11,6 +11,7 @@ Host <%= host %><% if keyfile %>
   def self.generate
     ([ Lakitu::MANAGED_SSH_CONFIG_TOKEN, Lakitu::FileOperator::local_ssh_config ] + instances.map do |instance|
       instance[:host] = format_for(instance[:provider], instance[:profile]) % instance
+      instance[:host].gsub!(/[ \W-]+/, '-')
       key_path = Lakitu::FileOperator.key_path instance[:key]
       instance[:keyfile] = key_path if key_path
       ERB.new(CLAUSE_TEMPLATE).result(OpenStruct.new(instance).instance_eval { binding })

data/lib/lakitu/providers/aws.rb

@@ -4,6 +4,11 @@ require 'lakitu/provider'
 
 class Lakitu::Provider::Aws < Lakitu::Provider
   CREDENTIALS_PATH = '~/.aws/credentials'
+  REGIONS = %w(
+    us-east-1
+    us-west-1
+    us-west-2
+  )
   def profiles
     IniParse.parse(File.read(File.expand_path(CREDENTIALS_PATH))).to_hash.keys.reject() do |x| x == '__anonymous__' end
   rescue Errno::ENOENT
@@ -26,7 +31,7 @@ class Lakitu::Provider::Aws < Lakitu::Provider
   end
 
   def regions
-    [ 'us-east-1', 'us-west-1', 'us-west-2' ]
+    REGIONS
   end
 
   private

data/lib/lakitu/version.rb

@@ -1,3 +1,3 @@
 class LakituVersion
-  VERSION = "1.0.8"
+  VERSION = "1.0.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lakitu
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.9
 platform: ruby
 authors:
 - Bryan Conrad
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-29 00:00:00.000000000 Z
+date: 2016-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler