sonic-screwdriver 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d74c2f1afc6d149f9939ba2c14a3d0994b764da9
-  data.tar.gz: b5427517877def31a8f04d75ffb500a6f06dc38d
+  metadata.gz: 37ec82ca43bde6ed94fef35b7c6f275890be09f3
+  data.tar.gz: dcb1bbf176d88da619c25561b1f947b2cbc52e28
 SHA512:
-  metadata.gz: 91ce81d1298f9235c7fbddf58990ae0cf5b199a1215660a61e81a324402204582cbf71682570f1e606e6abd7e2401c7b1bcb5293fbd6e3fded1d1aa6fd27d326
-  data.tar.gz: e7f9c7d8671adffa763ff2606d275ff0c4a3b79c3a25a94090fedbaf0c6682c860b99627617ab1e7104c07815d9fd446aff455aa546449f4bab075cde4799cf3
+  metadata.gz: 36e8aee57411d03defaee3439abc17684f8aca3f1c8dac1c6203cd496e499e05b9bc3d93601f9dfa120d7b36c68fb728e2efe78e2369c144b21f5561ac4c571a
+  data.tar.gz: 70ec6d267b6db685832816648a51b6cb7495f652d74d91f2b4fd742298422b0d3151e1c916069ae3e272985006306d7ad9b6f1beec5120e8fc0833bc18f30ea8

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+This project *tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
+
+## [1.0.0]
+- sonic ecs-exec
+- sonic ecs-run
+- sonic execute
+- sonic list
+- sonic ssh

data/Gemfile.lock

@@ -2,19 +2,30 @@ PATH
   remote: .
   specs:
     sonic-screwdriver (0.0.1)
+      aws-sdk
       colorize
       hashie
       thor
+      tty-prompt
 
 GEM
   remote: https://rubygems.org/
   specs:
+    aws-sdk (2.9.42)
+      aws-sdk-resources (= 2.9.42)
+    aws-sdk-core (2.9.42)
+      aws-sigv4 (~> 1.0)
+      jmespath (~> 1.0)
+    aws-sdk-resources (2.9.42)
+      aws-sdk-core (= 2.9.42)
+    aws-sigv4 (1.0.0)
     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)
+    equatable (0.5.0)
     ffi (1.9.18)
     formatador (0.2.5)
     guard (2.14.1)
@@ -36,6 +47,7 @@ GEM
       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)
@@ -43,18 +55,22 @@ GEM
       ruby_dep (~> 1.2)
     lumberjack (1.0.12)
     method_source (0.8.2)
+    necromancer (0.4.0)
     nenv (0.3.0)
     notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
+    pastel (0.7.1)
+      equatable (~> 0.5.0)
+      tty-color (~> 0.4.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)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
     rspec (3.6.0)
       rspec-core (~> 3.6.0)
       rspec-expectations (~> 3.6.0)
@@ -77,6 +93,14 @@ GEM
     simplecov-html (0.10.1)
     slop (3.6.0)
     thor (0.19.4)
+    tty-color (0.4.2)
+    tty-cursor (0.4.0)
+    tty-prompt (0.12.0)
+      necromancer (~> 0.4.0)
+      pastel (~> 0.7.0)
+      tty-cursor (~> 0.4.0)
+      wisper (~> 1.6.1)
+    wisper (1.6.1)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,39 +1,172 @@
 # Sonic
 
-[![Build Status](https://magnum.travis-ci.com/)](https://magnum.travis-ci.com/)
-[![Code Climate](https://codeclimate.com/)](https://codeclimate.com/)
-[![Code Climate](https://codeclimate.com/)](https://codeclimate.com/)
+Sonic is a multi-functional tool that helps you manage AWS resources. Sonic contains is a group of commands that help debug EC2 instances and ECS containers quickly.
 
-To these the sonic, run these commands:
+## Why Sonic Was Created
 
-TODO: Write a gem description
+After I exhaust debugging an ECS service with CloudWatch Logs I usually take it to the the next step: ssh into the instance. I jump into an instance with a running task or docker container and poke around to figure out the root issue.
 
-## Installation
+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. While this process is not complicated, it is tedious.  For example, the typical process is:
 
-Add this line to your application's Gemfile:
+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
 
-    gem 'sonic'
+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 mental energy clicking on links and use it to focus on better things like fixing the **actual** issue.
 
-And then execute:
+## Install
 
-    $ bundle
+### Install Via RubyGems
 
-Or install it yourself as:
+```
+gem install sonic-screwdriver
+```
 
-    $ gem install sonic
+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 `sonic-screwdriver` but the command is `sonic`.
+
+## Requirements
+
+* [jq](https://stedolan.github.io/jq/manual/) - a lightweight and flexible command-line JSON processor
+
+If you are also using the `ecs-exec` and `ecs-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 `sonic ssh` command then you do not need the jq dependency.
 
 ## Usage
 
-<pre>
-git clone https://github.com/tongueroo/sonic.git
-mv sonic <project_name>
-cd <project_name>
-rake rename
-rm -rf .git
-git init
-git add .
-git commit -m 'init commit'
-</pre>
+### sonic ssh
+
+To ssh into the host or container instance where an ECS service called `my-service` is running, simply run:
+
+```
+$ sonic 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 `sonic` command chooses the first container instance that it finds.  If you need to ssh into a specific container instance, use `sonic ssh` instead.
+
+You can also use the instance id, container instance arn or task arn to ssh into the machine.  Examples:
+
+```
+$ sonic ssh my-ecs-service --cluster my-cluster # cluster is required or ~/.sonic/settings.yml
+$ sonic ssh i-067c5e3f026c1e801
+$ sonic ssh 7fbc8c75-4675-4d39-a5a4-0395ff8cd474
+$ sonic ssh 1ed12abd-645c-4a05-9acf-739b9d790170
+```
+
+### sonic ecs-exec
+
+`sonic 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:
+
+```
+$ sonic ecs-exec SERVICE bash
+$ sonic 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:
+
+```
+$ sonic 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.
+
+```
+$ sonic 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:
+
+```
+$ sonic ecs-exec 9f1dadc7-4f67-41da-abec-ec08810bfbc9 bash
+$ i-006a097bb10643e20
+```
+
+### sonic ecs-run
+
+The `sonic ecs-run` command is similar to the `sonic 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:
+
+```
+sonic ecs-run my-service bundle exec 'rake do:something'
+```
+
+The default command opens up a bash shell.
+
+```
+sonic ecs-run my-service # start a bash shell
+sonic ecs-run my-service bash # same thing
+```
+
+## Settings
+
+A `~/.sonic/settings.yml` file is useful to adjust the behavior of sonic. One of the useful options is the `service_clsuter`.  This optoin maps services to clusters.  This saves you from  typing the `--cluster` option every time.  Here is an example `~/.sonic/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:
+
+```
+sonic ssh hi-web-prod
+sonic ssh hi-clock-prod
+sonic ssh hi-worker-stag
+```
+
+Instead of what you normally would have to type:
+
+```
+sonic ssh hi-web-prod --cluster prod
+sonic ssh hi-clock-prod --cluster prod
+sonic ssh hi-worker-stag --cluster stag
+```
+
+## Help and CLI Options
+
+```
+sonic help
+sonic help ssh
+sonic help ecs-exec
+sonic help ecs-run
+```
+
+## Internals
+
+If are interested in the internal logic to achieve what the sonic commands it is detailed on the [wiki](https://github.com/boltopslabs/sonic/wiki).
 
 ## Contributing
 
@@ -41,4 +174,4 @@ git commit -m 'init commit'
 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
+5. Create new Pull Request

data/bin/sonic

@@ -1,7 +1,14 @@
 #!/usr/bin/env ruby
 
+# Trap ^C
+Signal.trap("INT") {
+  puts "\nCtrl-C detected. Exiting..."
+  sleep 1
+  exit
+}
+
 $:.unshift(File.expand_path('../../lib', __FILE__))
 require 'sonic'
 require 'sonic/cli'
 
-Sonic::CLI.start(ARGV)
+Sonic::CLI.start(ARGV)

data/docs/.gitignore

@@ -0,0 +1,4 @@
+_site
+.sass-cache
+.jekyll-metadata
+Gemfile.lock

data/docs/CNAME

@@ -0,0 +1 @@
+sonic-screwdriver.cloud

data/docs/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem "jekyll"

data/docs/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 BoltOps
+
+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/docs/README.md

@@ -0,0 +1,21 @@
+# Sonic Screwdriver Documentation
+
+This project powers the sonic documementation website: [sonic-screwdriver.cloud](http://sonic-screwdriver.cloud).  It is a static website generated by [Jekyll](https://jekyllrb.com/).
+
+## Contributing
+
+For minor changes like typos, you can click **Suggest an edit to this page**, located at the bottom of each article. This will take you to the source file on GitHub, where you can submit a pull request for your change through the UI.
+
+## Local Setup
+
+For larger fixes, you can run the site locally with the following:
+
+```
+git clone https://github.com/boltopslabs/sonic.git
+cd sonic/docs
+bundle
+jekyll clean
+jekyll serve
+```
+
+You'll be able to view the site on [http://localhost:4000](http://localhost:4000).

data/docs/_config.yml

@@ -0,0 +1,69 @@
+# Site settings
+title: Sonic Screwdriver
+email: tung@boltops.com
+url: http://sonic-screwdriver.cloud
+description: "Multi-functional tool to manage AWS infrastructure"
+keywords: "AWS EC2 Container Service, AWS ECS, AWS EC2, ssh, debug, docker run, docker exec, productivity, tool"
+skills: ""
+meta_author: Tung Nguyen
+
+# Google webmaster tools
+google_verify:
+
+# https://ssl.bing.com/webmaster/configure/verify/ownership Option 2 content= goes here
+bing_verify:
+
+# Contact form:
+# - static : pass through formspree.io to validate email sending
+# - disqus : replace contact form by disqus thread
+# - comment the line below if you want to stick with the default PHP contact form
+contact: static
+
+# If you use disqus you need disqus shortname
+# https://help.disqus.com/customer/portal/articles/466208
+disqus_shortname:
+
+# Color settings (hex-codes without the leading hash-tag)
+color:
+  primary: 3972c7
+  primary-rgb: "24,288,156" #"128,179,255"
+  secondary: 2c3e50 #FD6E8A
+  secondary-dark: 233140 #A2122F
+  links: a3c8ff
+
+# Footer settings
+footer:
+  copyright: BoltOps, LLC
+  location: San Francisco, CA
+  social: BoltOps
+  credits:
+  contact: contact@boltops.com
+  phone:
+
+# Social networks usernames (many more available: google-plus, flickr, dribbble, pinterest, instagram, tumblr, linkedin, etc.)
+social:
+  - title: twitter
+    url: http://twitter.com/boltopslabs
+  - title: github
+    url: http://github.com/boltopslabs
+
+# Credits content
+credits: 'BoltOps, LLC'
+
+# Build settings
+markdown: kramdown
+permalink: pretty
+
+gh_url: "https://github.com/boltopslabs/sonic"
+
+collections:
+  docs:
+    name: "Documentation"
+    output: true
+
+defaults:
+  - values:
+      layout: default
+
+plugins_dir:
+ - jekyll-coffeescript