bolts-ssh 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d929ba149173bde3cd4c3ff0ed2fba832b6bad07
+  data.tar.gz: 9f583744991efe725fcd415dc88454725ba51076
+SHA512:
+  metadata.gz: afc159445edad238166bbf36dd1a449d0bcde0654c3e8d774e675834ae744536688b066ee81c6607324870ade2ed063f39bb7dae5fc56218ff92e4953fa85930
+  data.tar.gz: c7ebd163ca1322304896108bf381d1d9d6e22d0e525de1c00a5a4ab36c0c439509818641f8a611d53d3929febbbcc59c4952eb09b886cf722e874f30a6fbf521

data/.gitignore

@@ -0,0 +1,16 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bolts.gemspec
+gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/Gemfile.lock

@@ -0,0 +1,106 @@
+PATH
+  remote: .
+  specs:
+    bolts-ssh (0.0.1)
+      aws-sdk
+      colorize
+      hashie
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aws-sdk (2.9.17)
+      aws-sdk-resources (= 2.9.17)
+    aws-sdk-core (2.9.17)
+      aws-sigv4 (~> 1.0)
+      jmespath (~> 1.0)
+    aws-sdk-resources (2.9.17)
+      aws-sdk-core (= 2.9.17)
+    aws-sigv4 (1.0.0)
+    byebug (9.0.6)
+    codeclimate-test-reporter (1.0.8)
+      simplecov (<= 0.13)
+    coderay (1.1.1)
+    colorize (0.8.1)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    ffi (1.9.18)
+    formatador (0.2.5)
+    guard (2.14.1)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-bundler (2.1.0)
+      bundler (~> 1.0)
+      guard (~> 2.2)
+      guard-compat (~> 1.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    hashie (3.5.5)
+    jmespath (1.3.1)
+    json (2.1.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.12)
+    method_source (0.8.2)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (12.0.0)
+    rb-fsevent (0.9.8)
+    rb-inotify (0.9.8)
+      ffi (>= 0.5.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
+    simplecov (0.13.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    thor (0.19.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bolts-ssh!
+  bundler
+  byebug
+  codeclimate-test-reporter
+  guard
+  guard-bundler
+  guard-rspec
+  rake
+
+BUNDLED WITH
+   1.14.6

data/Guardfile

@@ -0,0 +1,12 @@
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})      { "spec/bolts_spec.rb" }
+  watch(%r{^lib/bolts/(.+)\.rb$})  { "spec/bolts_spec.rb" }
+  watch('spec/spec_helper.rb')   { "spec/bolts_spec.rb" }
+  watch(%r{^lib/bolts/(.+)\.rb$})   { |m| "spec/lib/#{m[1]}_spec.rb" }
+end
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tung Nguyen
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,196 @@
+# Bolts
+
+Bolts contains is a group of commands that help debug EC2 instance and ECS containers quickly.
+
+After I exhaust debugging an ECS service with CloudWatch Logs I usually take it to the the next step. I ssh into an instance with a running task or docker container and poke around to figure out the issue.
+
+In order to find the instance with the service's docker container I click around on the ECS console website until I find the container instance's DNS name and then paste it to the terminal. The process is not complicated but it is tedious.  For example, the typical process is:
+
+1. Click on the cluster
+2. Click on the service
+3. Click on the tasks tab
+4. Click on the one of the tasks
+5. Click on the container instance
+6. Highlight and copy the DNS name
+7. Paste the DNS name into the terminal to build up the ssh ec2-user@[dnsname] command
+8. Ssh into the machine
+9. Find the docker container with "docker ps"
+10. Run docker exec -ti [container_id] bash
+11. Finally, debug the actual problem
+
+By the time I get into the container, I need to remind my brain on what the original issue was.  This tool automates that process so you do not waste your precious finger energy clicking on links and use it to focus on better things like fixing the actual issue.
+
+## Install
+
+Locally on your machine.
+
+```
+gem install bolts-ssh
+```
+Set up your AWS credentials at `~/.aws/credentials` and `~/.aws/config`.  This is the [AWS standard way of setting up credentials](https://aws.amazon.com/blogs/security/a-new-and-standardized-way-to-manage-credentials-in-the-aws-sdks/).
+
+Note that the gem is named `bolts-ssh` but the command is `bolts`.
+
+## Requirements
+
+* [jq](https://stedolan.github.io/jq/manual/) - a lightweight and flexible command-line JSON processor
+
+If you are also using the `exec` and `run` commands, then you will need to ensure that [jq](https://stedolan.github.io/jq/) is installed on all of your ECS container instances.  If you are only using the `bolts ssh` command then you do not need the jq dependency.
+
+## Usage
+
+### bolts ssh
+
+To ssh into the host or container instance where an ECS service called `my-service` is running, simply run:
+
+```
+$ bolts ssh my-service --cluster my-cluster
+# now you are on the container instance
+$ docker ps
+$ curl -s http://localhost:51678/v1/meta | jq .
+```
+
+The `my-service` can possible run on multiple container instances.  The `bolts` command chooses the first container instance that it finds.  If you need to ssh into a specific container instance, use `bolts ssh` instead.
+
+You can also use the instance id, container instance arn or task arn to ssh into the machine.  Examples:
+
+```
+$ bolts ssh my-ecs-service --cluster my-cluster # cluster is required or ~/.bolts/settings.yml
+$ bolts ssh i-067c5e3f026c1e801
+$ bolts ssh 7fbc8c75-4675-4d39-a5a4-0395ff8cd474
+$ bolts ssh 1ed12abd-645c-4a05-9acf-739b9d790170
+```
+
+### bolts ecs-exec
+
+`bolts ecs-exec` will hop one more level and get you all the way into a live container for a service.  To quickly get yourself into a docker exec bash shell for a service:
+
+```
+$ bolts ecs-exec SERVICE bash
+$ bolts ecs-exec SERVICE # same as above, defaults to bash shell
+```
+
+This ultimately runs the following command after it ssh into the container instance:
+
+```
+$ docker run -ti SERVICE_CONTAINER bash
+```
+
+Here are examples to show what is possible:
+
+```
+$ bolts ecs-exec my-service bash
+# You're in the docker container now
+$ ls # check out some files to make sure you're the right place
+$ ps auxxx | grep puma # is the web process up?
+$ env # are the environment variables properly set?
+$ bundle exec rails c # start up a rails console to debug
+```
+
+You can also pass in bundle exec rails console if you want to get to that as quickly as possible.
+
+```
+$ bolts ecs-exec my-service 'bundle exec rails console'
+# You're a rails console in the docker container now
+> User.count
+```
+
+You must put commands with spaces in quotes.
+
+You can also use the container instance id or instance id in place of the service name:
+
+```
+$ bolts ecs-exec 9f1dadc7-4f67-41da-abec-ec08810bfbc9 bash
+$ i-006a097bb10643e20
+```
+
+### bolts ecs-run
+
+The `bolts ecs-run` command is similar to the `bolts ecs-exec` command except it'll run a brand new container with the same environment variables as the task associated with the service. This allows you to debug in a container with the exact environment variables as the running tasks/containers without affecting the live service. So this is safer since you will not be able to mess up a live container that is in service.
+
+This also allows you to run one off commands like a rake task. Here's an example:
+
+```
+bolts ecs-run my-service bundle exec 'rake do:something'
+```
+
+The default command opens up a bash shell.
+
+```
+bolts ecs-run my-service # start a bash shell
+bolts ecs-run my-service bash # same thing
+```
+
+## Settings
+
+A `~/.bolts/settings.yml` file is support that maps services to clusters.  This is very useful if you get tired of typing the `--cluster` option every time.  Here is an example `~/.bolts/settings.yml`:
+
+```yaml
+service_cluster:
+  default: my-default-cluster
+  hi-web-prod: prod
+  hi-clock-prod: prod
+  hi-worker-prod: prod
+  hi-web-stag: stag
+  hi-clock-stag: stag
+  hi-worker-stag: stag
+```
+
+This results in shorter commands:
+
+```
+bolts ssh hi-web-prod
+bolts ssh hi-clock-prod
+bolts ssh hi-worker-stag
+```
+
+Instead of what you normally would have to type:
+
+```
+bolts ssh hi-web-prod --cluster prod
+bolts ssh hi-clock-prod --cluster prod
+bolts ssh hi-worker-prod --cluster stag
+```
+
+## Help and CLI Options
+
+```
+bolts help
+bolts help ssh
+bolts help ecs-exec
+bolts help ecs-run
+```
+
+## Internals
+
+The process that I outline about click around is close to the logic that actually takes place in the tool but is slightly different. Here's an overview of what actually happens internally for those who are interested.
+
+I thought it would be possible to map the container instance info from `aws ecs describe-services` but it is not possible. But we can map to the container instance DNS name starting from `aws ecs list-tasks`.
+
+Steps:
+
+1. list-tasks: list all the tasks for their task_arns (scoped to service).  this is all tasks on the service.  We already know the service name!
+2. describe-tasks: Using the task_arns from list-tasks. This will provide the container instance scoped the service since list-tasks was scoped to service.  Keep the task arn for step 7. Also describe-task-definition and capture env vars and image for step 8b.
+3. describe-container-instances: Using container\_instance\_arn from step 2. This will provide the instance_id to ssh into.
+4. ec2 describe-instances to get the dns name or IP address.
+5. Copy over files with required info over to the server with scp.
+6. ssh into the machine with IP address.
+7. Use the ecs metadata and pass it the task_arn from step 2. This will provide the map to the container id.
+8. Run docker command
+  * a) docker exec -ti CONTAINER_ID `options[:command]`
+  * b) docker run `options[:run_options]` IMAGE `options[:command]`
+
+In order to pass info over from your local machine to the container instance a file is generated and copied in step 5. File contains:
+
+* Options all the way from the original cli call like command to run. This is in json form.
+A bash script is also copied.
+* Bash script gets the container id using the task_arn. It also will run the docker exec or run command.
+* So bash script does steps 7 and 8a or 8b.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/bin/bolts

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.expand_path('../../lib', __FILE__))
+require 'bolts'
+require 'bolts/cli'
+
+Bolts::CLI.start(ARGV)

data/bolts.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bolts/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bolts-ssh"
+  spec.version       = Bolts::VERSION
+  spec.authors       = ["Tung Nguyen"]
+  spec.email         = ["tongueroo@gmail.com"]
+  spec.description   = %q{A collection of tools commands to debug EC2 and ECS quickly}
+  spec.summary       = %q{Ssh into an EC2 instance quickly. Docker run or docker exec with running ECS container quickly.}
+  spec.homepage      = "https://github.com/bolts/bolts"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thor"
+  spec.add_dependency "hashie"
+  spec.add_dependency "colorize"
+  spec.add_dependency "aws-sdk"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-bundler"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "byebug"
+end

data/lib/bash_scripts/docker-exec.sh

@@ -0,0 +1,15 @@
+#!/bin/bash -xe
+
+TASK_ARN=$(cat /tmp/bolts/task-arn.txt)
+CONTAINER_ID=$(curl -s http://localhost:51678/v1/tasks | jq ".Tasks[] | select(.Arn ==  \"$TASK_ARN\")" | jq -r '.Containers[].DockerId' | head -1)
+
+# Got all the info in memory now we need os we can clean the files
+rm -rf /tmp/bolts
+
+if [ $1 ]; then
+  COMMAND=$@
+else
+  COMMAND=bash
+fi
+
+exec docker exec -ti $CONTAINER_ID $COMMAND

data/lib/bash_scripts/docker-run.sh

@@ -0,0 +1,15 @@
+#!/bin/bash -x
+
+CONTAINER_IMAGE=$(cat /tmp/bolts/docker-image.txt)
+
+# Got all the info in memory now we need os we can clean the files
+# rm -rf /tmp/bolts
+# Cannot remove files until we are done using the --env-file
+
+# Maybe do this later.  But will need to have bolts path be unique.
+# at -f "/tmp/bolts/seppuku.sh" now + 1.minute
+
+cp /tmp/bolts/env-file.txt ~/
+rm -rf /tmp/bolts
+
+exec docker run -ti --env-file ~/env-file.txt $CONTAINER_IMAGE "$@"

data/lib/bolts.rb

@@ -0,0 +1,12 @@
+$:.unshift(File.expand_path("../", __FILE__))
+require "bolts/version"
+require "aws-sdk"
+
+module Bolts
+  autoload :Settings, 'bolts/settings'
+  autoload :Defaults, 'bolts/defaults'
+  autoload :CLI, 'bolts/cli'
+  autoload :AwsServices, 'bolts/aws_services'
+  autoload :Ssh, 'bolts/ssh'
+  autoload :Docker, 'bolts/docker'
+end

data/lib/bolts/aws_services.rb

@@ -0,0 +1,11 @@
+module Bolts
+  module AwsServices
+    def ecs
+      @ecs ||= Aws::ECS::Client.new
+    end
+
+    def ec2
+      @ec2 ||= Aws::EC2::Client.new
+    end
+  end
+end

data/lib/bolts/cli.rb

@@ -0,0 +1,29 @@
+require 'thor'
+require 'bolts/cli/help'
+
+module Bolts
+  class CLI < Thor
+    class_option :verbose, type: :boolean
+    class_option :noop, type: :boolean
+    class_option :cluster, desc: "ECS Cluster to use.  Default cluster is default"
+
+    desc "ssh IDENTIFER", "ssh into a instance using identifier. identifer can be be service name or instance id"
+    long_desc Help.ssh
+    def ssh(service, *command)
+      Ssh.new(service, options.merge(command: command)).run
+    end
+
+    desc "ecs-exec SERVICE", "docker exec into running docker container associated with the service on a container instance"
+    long_desc Help.ecs_exec
+    def ecs_exec(service, *command)
+      Docker.new(service, options.merge(command: command)).exec
+    end
+
+    # Cannot name the command run because that is a reserved Thor keyword :(
+    desc "ecs-run SERVICE", "docker run with the service on a container instance"
+    long_desc Help.ecs_run
+    def ecs_run(service, *command)
+      Docker.new(service, options.merge(command: command)).run
+    end
+  end
+end

data/lib/bolts/cli/help.rb

@@ -0,0 +1,67 @@
+# https://github.com/erikhuda/thor/issues/398
+class Thor
+  module Shell
+    class Basic
+      def print_wrapped(message, options = {})
+        pretty_message = message.split("\n").map{|l| "  #{l}"}.join("\n")
+        stdout.puts pretty_message
+      end
+    end
+  end
+end
+
+module Bolts
+  class CLI < Thor
+    class Help
+      class << self
+        def ssh
+<<-EOL
+Ssh quicky into an EC2 instance using an identifier. The identifier can be many
+different things:
+
+* EC2 instance id. Example: i-067c5e3f026c1e801
+* ECS service. Example: my-ecs-service
+* ECS container instance id. Example: 7fbc8c75-4675-4d39-a5a4-0395ff8cd474
+* ECS task id. Example: 1ed12abd-645c-4a05-9acf-739b9d790170
+
+Examples:
+
+$ bolts ssh my-ecs-service --cluster my-cluster # cluster is required or ~/.bolts/settings.yml
+$ bolts ssh i-067c5e3f026c1e801
+$ bolts ssh 7fbc8c75-4675-4d39-a5a4-0395ff8cd474
+$ bolts ssh 1ed12abd-645c-4a05-9acf-739b9d790170
+EOL
+        end
+
+        def ecs_exec
+<<-EOL
+Ssh into an ECS container instance, finds a running docker container associated
+with the service and docker exec's into it.
+
+Examples:
+
+$ bolts ecs-exec my-service --cluster my-cluster
+EOL
+        end
+
+        def ecs_run
+<<-EOL
+Ssh into an ECS container instance and runs a docker container using the same
+environment and image as the specified running service.
+
+Examples:
+
+$ bolts ecs-run my-service --cluster my-cluster
+$ bolts ecs-run my-service --cluster my-cluster
+
+# If there are flags in the command that you want to pass down to the docker
+run command you will need to put the command in single quotes.  This is due to
+the way Thor (what this tool uses) parses options.
+
+$ bolts ecs-run --cluster prod-hi hi-web-prod 'rake -T'
+EOL
+        end
+      end
+    end
+  end
+end

data/lib/bolts/defaults.rb

@@ -0,0 +1,32 @@
+module Bolts
+  # To include this module must have this in initialize:
+  #
+  # def initialize(optiions, ...)
+  #   @options = options
+  #   ...
+  # end
+  #
+  # So @options must be set
+  module Defaults
+    # user: 123456789.dkr.ecr.us-east-1.amazonaws.com/bolts
+    # service_cluster:
+    #   default: prod-lo
+    #   hi-web-prod: prod-hi
+    #   hi-clock-prod: prod-lo
+    #   hi-worker-prod: prod-lo
+    #
+    # Assumes that @service is set in the class that the Defaults module is included in.
+    def default_cluster
+      service_cluster = settings.data["service_cluster"]
+      service_cluster[@service] || service_cluster["default"]
+    end
+
+    def default_user
+      settings.data["user"] || "ec2-user"
+    end
+
+    def settings
+      @settings ||= Settings.new(@options[:project_root])
+    end
+  end
+end

data/lib/bolts/docker.rb

@@ -0,0 +1,80 @@
+require 'fileutils'
+
+module Bolts
+  class Docker < Ssh
+    def setup
+      check_service_exists!
+      check_tasks_running!
+      create_container_data
+      black_hole = " > /dev/null" unless @options[:verbose]
+      black_hold = ''
+      execute("scp -r #{data_path} #{ssh_host}:#{data_path} #{black_hole}")
+      FileUtils.rm_rf(data_path) # clean up locally
+      # the docker-exec.sh cleans up after itself and blows away /tmp/bolts
+    end
+
+    def exec
+      setup
+      docker_exec = "/tmp/bolts/bash_scripts/docker-exec.sh"
+      kernel_exec("ssh", "-t", ssh_host, "bash #{docker_exec}")
+    end
+
+    # I cannot name this run like 'docker run' because run is a keyword in Thor.
+    def run
+      setup
+      docker_run = "/tmp/bolts/bash_scripts/docker-run.sh"
+      # args = ["ssh", ssh_host, "bash #{docker_run} #{options[:docker_options]}"].compact
+      args = ["ssh", "-t", ssh_host, "bash", docker_run, @options[:docker_command]].compact
+      kernel_exec(*args)
+    end
+
+    def data_path
+      "/tmp/bolts"
+    end
+
+    def execute(command)
+      puts "Running: #{command}"
+      system(command)
+    end
+
+    # Data that is needed in order to run a new docker container that mimics the
+    # docker container that is already running:
+    #   * task_arn
+    #   * env_vars
+    #   * image
+    def create_container_data
+      # For container env_vars and image info.
+      task_definition_arn = task.task_definition_arn # task is a method in the superclass: Ssh
+      response = ecs.describe_task_definition(task_definition: task_definition_arn)
+      task_definition = response.to_h[:task_definition]
+      container_definition = task_definition[:container_definitions].first # assumes care about the first container definition
+      env_file_data = env_file_data(container_definition[:environment])
+
+      bolts_folder = "/tmp/bolts"
+      FileUtils.mkdir_p(bolts_folder) unless File.exist?(bolts_folder)
+      IO.write("/tmp/bolts/task-arn.txt", task_arns.first)
+      IO.write("/tmp/bolts/docker-image.txt", container_definition[:image])
+      IO.write("/tmp/bolts/env-file.txt", env_file_data)
+      FileUtils.cp_r(bash_scripts, "/tmp/bolts")
+    end
+
+    # environment - [{:name=>"AUTH_TOKEN", :value=>"xxx"}, {:name=>"RAILS_LOG_TO_STDOUT", :value=>"1"}]
+    #
+    # Returns String with a simple form, the docker --env-file format
+    #
+    #   AUTH_TOKEN=xxx
+    #   RAILS_LOG_TO_STDOUT=1
+    def env_file_data(environment)
+      variables = []
+      environment.each do |item|
+        variables << "#{item[:name]}=#{item[:value]}"
+      end
+      variables.join("\n")
+    end
+
+    def bash_scripts
+      File.expand_path("../../bash_scripts", __FILE__)
+    end
+
+  end
+end

data/lib/bolts/settings.rb

@@ -0,0 +1,41 @@
+require 'yaml'
+
+module Bolts
+  class Settings
+    def initialize(project_root='.')
+      @project_root = project_root
+    end
+
+    def data
+      return @data if @data
+
+      @data = defaults
+      if File.exist?(settings_path)
+        custom_data = YAML.load_file(settings_path)
+        @data.merge!(custom_data)
+        ensure_default_cluster(@data)
+      end
+      @data
+    end
+
+    def defaults
+      {
+        "user" => "ec2-user",
+        "service_cluster" => {"default" => "default"}
+      }
+    end
+
+    # When user's .bolts/settings.yml lack the default cluster, we add it on.
+    # Otherwise the user get confusing and scary aws-sdk-core/param_validator errors:
+    # Example: https://gist.github.com/bolts/67b9a68a77363b908d1c36047bc2709a
+    def ensure_default_cluster(data)
+      unless @data["service_cluster"]["default"]
+        @data["service_cluster"]["default"] = "default"
+      end
+    end
+
+    def settings_path
+      "#{ENV['HOME']}/.bolts/settings.yml"
+    end
+  end
+end

data/lib/bolts/ssh.rb

@@ -0,0 +1,148 @@
+require 'colorize'
+
+module Bolts
+  class Ssh
+    include Defaults
+    include AwsServices
+
+    def initialize(identifier, options)
+      @options = options
+      @identifier = identifier
+      @service = @identifier # always set service even though sometimes it is not the identifier
+      @cluster = options[:cluster] || default_cluster
+      @user = options[:user] || default_user
+    end
+
+    def run
+      exit_on_specs
+      check_cluster_exists! unless instance_id?
+      kernel_exec("ssh", ssh_host)
+    end
+
+    # hack to test CLI call logic up to this class
+    def exit_on_specs
+      if ENV['TEST']
+        puts "ssh into ..."
+        exit 0
+      end
+    end
+
+    # used by child Classes
+    def ssh_host
+      @ssh_host ||= build_ssh_host
+    end
+
+    def build_ssh_host
+      ec2_instance_id = if instance_id?
+                          @identifier
+                        elsif container_instance_or_task_arn?
+                          find_by_container_instance(@identifier) ||
+                          find_by_task(@identifier)
+                        else # service name
+                          check_service_exists!
+                          check_tasks_running!
+                          container_instance_arn = task.container_instance_arn
+                          find_by_container_instance(container_instance_arn)
+                        end
+      instance_hostname(ec2_instance_id)
+    end
+
+    def find_by_task(task_arn)
+      response = ecs.describe_tasks(
+                    cluster: @cluster,
+                    tasks: [task_arn])
+      task = response.tasks.first
+      unless task
+        puts "Unable to find a #{task_arn.green} container instance or task in the #{@cluster.green} cluster."
+        exit 1
+      end
+      find_by_container_instance(task.container_instance_arn)
+    end
+
+    def find_by_container_instance(container_instance_arn)
+      response = ecs.describe_container_instances(
+                    cluster: @cluster,
+                    container_instances: [container_instance_arn])
+      container_instance = response.container_instances.first
+      unless container_instance
+        return false
+      end
+      ec2_instance_id = container_instance.ec2_instance_id
+    end
+
+    def check_cluster_exists!
+      cluster = ecs.describe_clusters(clusters: [@cluster]).clusters.first
+      unless cluster
+        puts "The #{@cluster.green} cluster does not exist.  Are you sure you specified the right cluster?"
+        exit 1
+      end
+    end
+
+    def check_service_exists!
+      service = ecs.describe_services(services: [@service], cluster: @cluster).services.first
+      unless service
+        puts "The #{@service.green} service does not exist in #{@cluster.green} cluster.  Are you sure you specified the right service and cluster?"
+        exit 1
+      end
+    end
+
+    def check_tasks_running!
+      if task_arns.empty?
+        puts "Unable to find a running task that belongs to the #{@service} service on the #{@cluster} cluster."
+        puts "There must be a running task in order for bolts to look up an container instance."
+        exit 1
+      end
+    end
+
+    def instance_hostname(ec2_instance_id)
+      instance = ec2.describe_instances(instance_ids: [ec2_instance_id]).reservations[0].instances[0]
+      # struct Aws::EC2::Types::Instance
+      # http://docs.aws.amazon.com/sdkforruby/api/Aws/EC2/Types/Instance.html
+      host = instance.public_dns_name
+      "#{@user}@#{host}"
+    end
+
+    def task_arns
+      @task_arns ||= ecs.list_tasks(cluster: @cluster, service_name: @service).task_arns
+    end
+
+    # Only need one container instance to ssh into so we'll just use the first.
+    # Useful to have this in a method for subclasses like Bolts::Exec.
+    def task
+      @task ||= ecs.describe_tasks(cluster: @cluster, tasks: [task_arns.first]).tasks.first
+    end
+
+
+    # Will use Kernel.exec so that the ssh process takes over this ruby process.
+    def kernel_exec(*args)
+      # append the optional command that can be provided to the ssh command
+      full_command = args + @options[:command]
+      puts "Running: #{full_command.join(' ')}"
+      # https://ruby-doc.org/core-2.3.1/Kernel.html#method-i-exec
+      # Using 2nd form
+      Kernel.exec(*full_command)
+    end
+
+    # Examples:
+    #
+    # Container instance ids:
+    # b748e59a-b679-42a7-b713-afb12294935b
+    # 9f1dadc7-4f67-41da-abec-ec08810bfbc9
+    #
+    # Task ids:
+    # 222c9e66-780b-4755-8c16-8670988e8011
+    # 6358f9c2-b231-4f5b-a59b-15bf19d52a15
+    #
+    # Container instance and task ids have the same format
+    def container_instance_or_task_arn?
+      @identifier =~ /.{8}-.{4}-.{4}-.{4}-.{12}/
+    end
+
+    # Examples:
+    # i-006a097bb10643e20
+    def instance_id?
+      @identifier =~ /i-.{17}/
+    end
+
+  end
+end

data/lib/bolts/version.rb

@@ -0,0 +1,3 @@
+module Bolts
+  VERSION = "0.0.1"
+end

data/spec/lib/cli_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+# to run specs with what's remembered from vcr
+#   $ rake
+#
+# to run specs with new fresh data from aws api calls
+#   $ rake clean:vcr ; time rake
+describe Bolts::CLI do
+  before(:all) do
+    @args = "--cluster default"
+  end
+
+  describe "bolts" do
+    it "should hello world" do
+      out = execute("bin/bolts ssh my-service #{@args}")
+      expect(out).to include("ssh into")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+ENV['TEST'] = '1'
+
+require 'simplecov'
+SimpleCov.start
+
+require "pp"
+
+root = File.expand_path('../../', __FILE__)
+require "#{root}/lib/bolts"
+
+module Helpers
+  def execute(cmd)
+    puts "Running: #{cmd}" if ENV['DEBUG']
+    out = `#{cmd}`
+    puts out if ENV['DEBUG']
+    out
+  end
+end
+
+RSpec.configure do |c|
+  c.include Helpers
+end

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification
+name: bolts-ssh
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tung Nguyen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A collection of tools commands to debug EC2 and ECS quickly
+email:
+- tongueroo@gmail.com
+executables:
+- bolts
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/bolts
+- bolts.gemspec
+- lib/bash_scripts/docker-exec.sh
+- lib/bash_scripts/docker-run.sh
+- lib/bolts.rb
+- lib/bolts/aws_services.rb
+- lib/bolts/cli.rb
+- lib/bolts/cli/help.rb
+- lib/bolts/defaults.rb
+- lib/bolts/docker.rb
+- lib/bolts/settings.rb
+- lib/bolts/ssh.rb
+- lib/bolts/version.rb
+- spec/lib/cli_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bolts/bolts
+licenses:
+- MIT
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Ssh into an EC2 instance quickly. Docker run or docker exec with running
+  ECS container quickly.
+test_files:
+- spec/lib/cli_spec.rb
+- spec/spec_helper.rb