conssh 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3747759ebf30a2156d2a3e27b22bb5203010b91c4ce7ddb9c46fa5edcb3ec9da
+  data.tar.gz: 77808aa31fa8e883827484a657527aada101f5c932984c182da989c83ff526d1
+SHA512:
+  metadata.gz: 2553fd95a8a13aa3fcc942d1d662a094b2c9fdf035fa00b7b0ea8e2f49960c0af079b56dc18107b5e48edb5b49f762b5bc2c28183db42466ac743182adec0e38
+  data.tar.gz: 6843d3750e387672c5c911e8fcce5741c3d5084ec4a57ad39da63b8a8838d52ce02ceb4cfaaffd77cad6a5fbda2f0cbdea61a162f019e3d034d8cc4c0419fab6

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Don't include this in gems
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.5

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in conssh.gemspec
+gemspec

data/README.md

@@ -0,0 +1,52 @@
+# Conssh
+
+![A drawing of a conch shell](Conch_drawing.jpg)
+
+Conssh is a utility to configure SSH. It generates config files with connection
+information for a fleet of EC2 instances.
+
+Use it together with an autocompletion tool that understands SSH, like
+[bash-completion] or [fzf].
+
+Basic usage:
+
+```
+$ AWS_REGION=us-west-1 AWS_PROFILE=staging bundle exec conssh > ~/.ssh/config
+$ ssh …
+```
+
+[bash-completion]: https://github.com/scop/bash-completion
+[fzf]: https://github.com/junegunn/fzf
+
+## Background
+
+It is inspired by similar tools such as [ec2ssh] and [aws-ssh-config].
+
+This is experimental code. See the issues section for the work to make it more
+robust.
+
+Notable features:
+
+* Written in [Ruby] using version 3 of the [AWS SDK]
+* Unit tested using the [Moto] mock AWS API server
+* Packaged as a Ruby gem to use as a library or an executable
+
+[ec2ssh]: https://github.com/mirakui/ec2ssh
+[aws-ssh-config]: https://github.com/gianlucaborello/aws-ssh-config
+[Ruby]: https://www.ruby-lang.org/
+[AWS SDK]: https://github.com/aws/aws-sdk-ruby/
+[Moto]: https://github.com/spulec/moto
+
+## How do I get set up?
+
+See the [setup](setup.md) document for an early version step-by-step setup.
+
+## Demo
+
+Build the docker container and follow the instructions when the container runs.
+
+```bash
+cd demo
+docker build --tag demo .
+docker run -it demo
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/bundle

@@ -0,0 +1,105 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "rubygems"
+
+m = Module.new do
+    module_function
+
+  def invoked_as_script?
+    File.expand_path($0) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV["BUNDLER_VERSION"]
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
+        bundler_version = a
+      end
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
+      bundler_version = $1 || ">= 0.a"
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV["BUNDLE_GEMFILE"]
+    return gemfile if gemfile && !gemfile.empty?
+
+    File.expand_path("../../Gemfile", __FILE__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when "gems.rb" then gemfile.sub(/\.rb$/, gemfile)
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
+    Regexp.last_match(1)
+  end
+
+  def bundler_version
+    @bundler_version ||= begin
+      env_var_version || cli_arg_version ||
+        lockfile_version || "#{Gem::Requirement.default}.a"
+    end
+  end
+
+  def load_bundler!
+    ENV["BUNDLE_GEMFILE"] ||= gemfile
+
+    # must dup string for RG < 1.8 compatibility
+    activate_bundler(bundler_version.dup)
+  end
+
+  def activate_bundler(bundler_version)
+    if Gem::Version.correct?(bundler_version) && Gem::Version.new(bundler_version).release < Gem::Version.new("2.0")
+      bundler_version = "< 2"
+    end
+    gem_error = activation_error_handling do
+      gem "bundler", bundler_version
+    end
+    return if gem_error.nil?
+    require_error = activation_error_handling do
+      require "bundler/version"
+    end
+    return if require_error.nil? && Gem::Requirement.new(bundler_version).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+    warn "Activating bundler (#{bundler_version}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_version}'`"
+    exit 42
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+if m.invoked_as_script?
+  load Gem.bin_path("bundler", "bundle")
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "conssh"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/conssh

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'conssh' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("conssh", "conssh")

data/bin/htmldiff

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("diff-lcs", "htmldiff")

data/bin/ldiff

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'ldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("diff-lcs", "ldiff")

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/bin/ruby-parse

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'ruby-parse' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("parser", "ruby-parse")

data/bin/ruby-rewrite

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'ruby-rewrite' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("parser", "ruby-rewrite")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bitbucket-pipelines.yml

@@ -0,0 +1,20 @@
+image: ruby:2.5.0
+
+pipelines:
+  default:
+    - step:
+        caches:
+          - bundler
+          - pip
+          - pythonpackages
+        script:
+          - apt-get update
+          - apt-get --assume-yes install --yes python-pip
+          - pip install --user moto flask
+          - bundle install --path vendor/bundle
+          - MOTO_SERVER=~/.local/bin/moto_server rspec
+
+definitions:
+  caches:
+    bundler: ./vendor
+    pythonpackages: ~/.local

data/conssh.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "conssh/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "conssh"
+  spec.version       = Conssh::VERSION
+  spec.authors       = ["Iain Samuel McLean Elder"]
+  spec.email         = ["iainelder@hotmail.co.uk"]
+
+  spec.summary       = %q{Configure SSH to connect to an EC2 fleet}
+  spec.description   = <<~DESCRIPTION
+    Conssh is a utility to configure SSH. It generates config files with
+    connection information for a fleet of EC2 instances. Use it together with
+    an autocompletion tool that understands SSH, like bash-completion or fzf.
+  DESCRIPTION
+  spec.homepage      = "https://bitbucket.org/isme/conssh"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "aws-sdk-ec2", "~> 1.0"
+end

data/demo/Dockerfile

@@ -0,0 +1,7 @@
+FROM ubuntu:16.04
+
+COPY setup.sh run.sh /
+
+RUN /setup.sh
+
+CMD ["bash", "/run.sh"]

data/demo/run.sh

@@ -0,0 +1,32 @@
+#/bin/bash
+
+while : ; do
+  read -p "AWS Profile Name: " profile
+  if [[ "${profile}" = "" ]]; then
+    break
+  fi
+  aws configure --profile "${profile}"
+done
+
+read -p "Press a key to edit SSH private key."
+vim ~/.ssh/id_rsa
+
+read -p "Press a key to edit SSH public key."
+vim ~/.ssh/id_rsa.pub
+
+read -p "Press a key to edit host config."
+echo "
+Host <%= profile %>_<%= tags['Name'] %>_<%= instance_id %>
+  Hostname <%= public_dns_name %>
+" > ~/.ssh/ec2_host.erb
+vim ~/.ssh/ec2_host.erb
+
+echo "Generating SSH config..."
+profile_list=$(grep "\[" ~/.aws/credentials | tr -d '[]' | paste -sd ',' -)
+/ec2-ssh-config-generator/generate-config.rb "${profile_list}" > ~/.ssh/config
+
+echo "To regenerate: \`/ec2-ssh-config-generator/generate-config.rb ${profile_list} > ~/.ssh/config\`"
+
+echo "Type 'ssh **' then TAB to start!"
+
+bash

data/demo/setup.sh

@@ -0,0 +1,37 @@
+#!/bin/bash
+
+# A fresh Ubuntu image doesn't have a package list, so we need to update it
+# first before any of the install commands will work.
+apt-get update
+
+# The image doesn't have a bunch of things that you will expect to be there when
+# you setting up and playing around. I assume you know what these are, let's
+# just get them installed!
+apt-get install --yes vim less man wget git
+
+# The image doesn't have an SSH client either, so let's install that. We will
+# also quickly set up the usual files with the right permissions so that ssh
+# won't complain.
+apt-get install --yes openssh-client
+mkdir ~/.ssh/
+touch ~/.ssh/{known_hosts,config,id_rsa,id_rsa.pub}
+chmod --recursive 0600 ~/.ssh/
+
+# Installing AWS CLI is not strictly necessary, but it is the easiest way to
+# configure the AWS profiles.
+apt-get install --yes awscli
+
+# Install the best autocomplete tool.
+git clone --depth 1 https://github.com/junegunn/fzf.git ~/.fzf
+~/.fzf/install --all
+
+# The config generator is a Ruby app, so we need to install it.
+# The app is not packaged as a gem but installed from source, so we also have to use bundler
+# to install the other Ruby dependencies.
+apt-get install --yes ruby
+gem install bundler
+
+# Install the config generator.
+git clone https://isme@bitbucket.org/isme/ec2-ssh-config-generator.git
+cd ec2-ssh-config-generator
+bundle install

data/exe/conssh

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'conssh'
+
+conssh = Conssh::App.new
+conssh.generate_config

data/lib/conssh.rb

@@ -0,0 +1,8 @@
+require "conssh/version"
+require "conssh/inventory"
+require "conssh/config_writer"
+require "conssh/app"
+
+module Conssh
+  # Your code goes here...
+end

data/lib/conssh/app.rb

@@ -0,0 +1,10 @@
+require_relative 'inventory'
+require_relative 'config_writer'
+
+module Conssh
+  class App
+    def generate_config
+      ConfigWriter.new(:out => STDOUT).render(Inventory.new.hosts)
+    end
+  end
+end

data/lib/conssh/config_writer.rb

@@ -0,0 +1,22 @@
+module Conssh
+  class ConfigWriter
+
+    def initialize(args={})
+      @out = args[:out] || File.new('host_config', 'w+')
+    end
+
+    def render(inst)
+     first, *rest = *Array(inst)
+     render_one(first) if first
+     rest.each do |i|
+       @out.puts
+       render_one(i)
+     end
+    end
+
+    private def render_one(inst)
+      @out.puts("Host #{inst.id}")
+      @out.puts("HostName #{inst.public_ip_address}")
+    end
+  end
+end

data/lib/conssh/inventory.rb

@@ -0,0 +1,15 @@
+require 'aws-sdk-ec2'
+
+module Conssh
+  class Inventory
+
+    def initialize(args={})
+      args[:client] ||= Aws::EC2::Client.new
+      @ec2 = Aws::EC2::Resource.new(:client => args[:client])
+    end
+
+    def hosts
+      @ec2.instances.to_a
+    end
+  end
+end

data/lib/conssh/version.rb

@@ -0,0 +1,3 @@
+module Conssh
+  VERSION = "0.1.0"
+end

data/setup.md

@@ -0,0 +1,178 @@
+I assume you have just one SSH keypair to access all of your EC2 instances, and you keep it locally.
+
+I also assume you need to access instances in multiple accounts and multiple regions.
+
+I assume you have docker installed and ready to use in your environment.
+
+Before we start, get the all the credentials required to access the API of your AWS account and the SSH sessions of your EC2 instances.
+
+The brackets here are just a fancy way to generate filenames with a common prefix. Saves a bit of typing.
+
+```
+less ~/.aws/credentials ~/.ssh/id_rsa{,.pub}
+```
+
+Start a new Ubuntu container.
+
+```
+docker run -it ubuntu:16.04
+```
+
+A fresh Ubuntu image doesn't have a package list, so we need to update it first before any of the install commands will work.
+
+```
+apt-get update
+```
+
+The image doesn't have a bunch of things that you will expect to be there when you setting up and playing around. I assume you know what these are, let's just get them installed!
+
+```
+apt-get install vim less man wget git
+```
+
+The bash-completion package is also expected, and deserves a special mention here because it's what makes the magic happen later when have the correct SSH config.
+
+Change the default bindings to make the autocomplete behavior a bit nicer in bash.
+
+To make it take effect in the existing session we have to source the global profile again.
+
+```
+apt-get install bash-completion
+bind "TAB:menu-complete"
+bind "set show-all-if-ambiguous on"
+source /etc/profile
+```
+
+The image doesn't have an SSH client either, so let's install that.
+
+We will also quickly set up the usual file with the right permissions so that ssh won't complain.
+
+See way below for how to install a later version of the client that supports the Include directive.
+
+```
+apt-get install openssh-client
+mkdir ~/.ssh/
+touch ~/.ssh/{known_hosts,config,id_rsa,id_rsa.pub}
+chmod --recursive 0600 ~/.ssh/
+```
+
+While we are here, we can configure it with our SSH keys we will use to access the instances.
+
+```
+vim ~/.ssh/id_rsa
+vim ~/.ssh/id_rsa.pub
+```
+
+Installing AWS CLI is not strictly necessary, but it is the easiest way to configure the AWS profiles.
+
+Paste access key and secret key from aws credentials.
+
+Check it works by querying your user info.
+
+```
+apt-get install awscli
+aws configure --profile staging
+aws iam get-user --profile staging
+aws configure --profile production
+aws iam get-user --profile production
+```
+
+As ec2ssh is a Ruby gem, we first have to install Ruby so that we can use gem to install it.
+
+It unfortunately depends on the Nokogiri gem, so we have to install a bunch of other non-Ruby stuff to make it work.
+
+```
+apt-get install ruby
+apt-get install build-essential patch ruby-dev zlib1g-dev liblzma-dev
+gem install ec2ssh
+```
+
+Run init and check that an empty block is created and that the default config is set up.
+
+```
+ec2ssh init
+cat ~/.ssh/config
+cat ~/.ec2ssh
+```
+
+In the default config you'll see sections for sets of credentials and a list of regions.
+
+First let's set up the tool to query all regions so we are sure the list is complete.
+
+```
+aws ec2 describe-regions --region us-east-1 --query 'Regions[].RegionName' --output text
+```
+
+Paste the output of that command into the region directive (there is a commented-out example).
+
+```
+vim ~/.ec2ssh
+```
+
+The list is static, so you will have to update it when Amazon adds a new region. Thankfully here that happens relatvively infrequently.
+
+Unfortunately the program queries each region serially, so you might have a to wait a while. It would be great to do the queries in parallel, but it probably requires modifying the program.
+
+If you don't mind having a copy of your credentials in the ec2ssh config, then set up a staging and a production section with your keys.
+
+Otherwise see the next section for how to generate an equivalent ssh config using just the prodi
+
+If no credentials are set in the config, it will use whatever profile is set in the environment.
+
+If you prefer to manage all your AWS credentials as CLI profiles, then you simulate the behavior with a few extra steps.
+
+It would be awesome if the program was profile aware, but that probably requires modifying the program.
+
+```
+ec2ssh init --path ~/.ssh/config_staging
+AWS_PROFILE=staging ec2ssh update --path ~/.ssh/config_staging
+ec2ssh init --path ~/.ssh/config_production
+AWS_PROFILE=production ec2ssh update --path ~/.ssh/config_production
+```
+
+As of SSH 7.3 (Mac OS X Sierra has 7.4) , you can include these compartmentalizied configrations using the new Include directive.
+
+However, bash and zsh still don't support completion for included configs (although the feature appears to be on its way for zsh).
+
+For now, the easiest thing is just to combine the two configs together into one file.
+
+This also has the advantage of working with older versions of SSH that don't support the Include directive (Ubuntu Xenial has 7.2).
+
+```
+cat ~/.ssh/config_{staging,production} > ~/.ssh/config
+```
+
+Edit the config how we see fit.
+
+```
+vim ~/.ec2ssh # add public_ip_address
+ec2ssh update
+````
+
+Bunch of commands to install ssh 7.4, part of ubuntu's latest stable release (Zesty Zapus) and the same version on Mac OS X.
+
+```
+wget https://launchpad.net/ubuntu/+source/openssh/1:7.4p1-10/+build/12390736/+files/openssh-client_7.4p1-10_amd64.deb
+dpkg -i openssh-client_7.4p1-10_amd64.deb 
+wget https://launchpad.net/ubuntu/+source/openssh/1:7.4p1-10/+build/12390736/+files/ssh-krb5_7.4p1-10_all.deb
+dpkg -i ssh-krb5_7.4p1-10_all.deb 
+wget https://launchpad.net/ubuntu/zesty/amd64/libgssapi-krb5-2/1.15-1
+wget http://launchpadlibrarian.net/296470446/libgssapi-krb5-2_1.15-1_amd64.deb
+dpkg -i libgssapi-krb5-2_1.15-1_amd64.deb 
+wget http://launchpadlibrarian.net/296470457/libkrb5support0_1.15-1_amd64.deb
+dpkg -i libkrb5support0_1.15-1_amd64.deb 
+dpkg -i libgssapi-krb5-2_1.15-1_amd64.deb 
+wget http://launchpadlibrarian.net/296470455/libkrb5-3_1.15-1_amd64.deb
+deb -i libkrb5-3_1.15-1_amd64.deb 
+dbkg -i libkrb5-3_1.15-1_amd64.deb 
+dpkg -i libkrb5-3_1.15-1_amd64.deb 
+apt-get upgrade
+wget https://launchpad.net/ubuntu/+source/krb5/1.15-1/+build/11519847/+files/libk5crypto3_1.15-1_amd64.deb
+dpkg -i libk5crypto3_1.15-1_amd64.deb 
+deb -i libkrb5-3_1.15-1_amd64.deb 
+dpkg -i libkrb5-3_1.15-1_amd64.deb 
+ls *.deb
+dpkg -i openssh-client_7.4p1-10_amd64.deb
+dpkg -i libgssapi-krb5-2_1.15-1_amd64.deb
+dpkg -i openssh-client_7.4p1-10_amd64.deb
+```

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: conssh
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Iain Samuel McLean Elder
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-ec2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: |
+  Conssh is a utility to configure SSH. It generates config files with
+  connection information for a fleet of EC2 instances. Use it together with
+  an autocompletion tool that understands SSH, like bash-completion or fzf.
+email:
+- iainelder@hotmail.co.uk
+executables:
+- conssh
+extensions: []
+extra_rdoc_files: []
+files:
+- ".bundle/config"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Conch_drawing.jpg
+- Gemfile
+- README.md
+- Rakefile
+- bin/bundle
+- bin/console
+- bin/conssh
+- bin/htmldiff
+- bin/ldiff
+- bin/rake
+- bin/rspec
+- bin/rubocop
+- bin/ruby-parse
+- bin/ruby-rewrite
+- bin/setup
+- bitbucket-pipelines.yml
+- conssh.gemspec
+- demo/Dockerfile
+- demo/run.sh
+- demo/setup.sh
+- exe/conssh
+- lib/conssh.rb
+- lib/conssh/app.rb
+- lib/conssh/config_writer.rb
+- lib/conssh/inventory.rb
+- lib/conssh/version.rb
+- setup.md
+homepage: https://bitbucket.org/isme/conssh
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Configure SSH to connect to an EC2 fleet
+test_files: []