sonic-screwdriver 1.3.0 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd37ca876dccfeb67a1540e2af0f312fafcde6a3
-  data.tar.gz: c728fd9cf1da7019cc2738912d372f937e36704d
+  metadata.gz: 2d34eb785d89e9c4a826928df596cecb363fb646
+  data.tar.gz: 547ef19add839f6edb57e524733be8bd94436b02
 SHA512:
-  metadata.gz: 04f2e8e50729ca19e70a5fdd720cdcef5bdbe1bef20f14c93287811ba44ca8864760715ab55af8a93ce609d3b4759cbb1c304640e981d765b72143f49deec99d
-  data.tar.gz: 67357d39582de07b37672ae14a101515afe8eb9be1569199a2eaa0b9f59226577c444a25530f8067427973351f04309fc0ec5ca7a56ca2d478462f988a19df24
+  metadata.gz: 01d05f3716d252a66370cd62e18a13d02761dd5a5620b1b18b011577d7251bbeb870d1ec022d64986c22f3871cc5ad35fcff9e80ea7c3bdbbdf8bdc2c030f53e
+  data.tar.gz: e453e4568efd83dbb6a6f8c649711c035767b001a45cda04de34fe6e69d2f60baeff587d7025923c7d66e34f38354924f74faf96a70d76e827a6bb195b0f599e

data/CHANGELOG.md

@@ -3,6 +3,13 @@
 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.3.1]
+- Add sonic ssh -i option so users can specify custom private keys.
+- Add sonic ssh -r retry option so you don't have to keep pressing up enter.
+
+## [1.3.1]
+- remove byebug debugging
+
 ## [1.3.0]
 - support for different bastion cluster host mapping in settings
 

data/CONTRIBUTING.md

@@ -0,0 +1,56 @@
+# Contributing to Sonic Screwdriver
+
+Contributing is welcomed and encouraged.  We love pull requests!
+
+Here are some ways *you* can contribute:
+
+* by reporting bugs
+* by suggesting new features
+* by writing or editing documentation
+* by writing specs
+* by writing code ( **no patch is too small** : fix typos, add comments, clean up inconsistent whitespace )
+* by refactoring code
+* by closing [issues][]
+* by reviewing patches
+
+[issues]: https://github.com/tongueroo/lono/issues
+
+## Submitting an Issue
+
+* We use the [GitHub issue tracker][issues] to track bugs and features.
+* Before submitting a bug report or feature request, check to make sure it hasn't
+already been submitted.
+* When submitting a bug report, please include a [Gist][] that includes a stack
+  trace and any details that may be necessary to reproduce the bug, including
+  your gem version, Ruby version, and operating system.  Ideally, a bug report
+  should include a pull request with failing specs.
+
+[gist]: https://gist.github.com/
+
+## Cleaning up issues
+
+* Issues that have no response from the submitter will be closed after 30 days.
+* Issues will be closed once they're assumed to be fixed or answered. If the
+  maintainer is wrong, it can be opened again.
+* If your issue is closed by mistake, please understand and explain the issue.
+  We will happily reopen the issue.
+
+## Submitting a Pull Request
+1. [Fork][fork] the [official repository][repo].
+2. [Create a topic branch.][branch]
+3. Implement your feature or bug fix.
+4. Add, commit, and push your changes.
+5. [Submit a pull request.][pr]
+
+## Notes
+* Please add tests if you changed code. Contributions without tests won't be accepted.
+* If you don't know how to add tests, please put in a PR and leave a comment
+  asking for help. We love helping!
+* Please don't update the Gem version.
+
+[repo]: https://github.com/tongueroo/lono/tree/master
+[fork]: https://help.github.com/articles/fork-a-repo/
+[branch]: https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/
+[pr]: https://help.github.com/articles/using-pull-requests/
+
+Inspired by https://github.com/middleman/middleman-heroku/blob/master/CONTRIBUTING.md

data/README.md

@@ -1,21 +1,23 @@
 # Sonic Screwdriver
 
 [![CircleCI](https://circleci.com/gh/boltopslabs/sonic.svg?style=svg)](https://circleci.com/gh/boltopslabs/sonic)
+[![Gitter](https://badges.gitter.im/boltopslabs/sonic.svg)](https://gitter.im/boltopslabs/sonic?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
+[![Support](https://img.shields.io/badge/get-support-blue.svg)](https://boltops.com?utm_source=badge&utm_medium=badge&utm_campaign=sonic)
 
-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.
+Sonic is a multi-functional tool that helps you manage AWS resources. Sonic contains a group of commands that help debug EC2 instances and ECS containers quickly.
 
 See [sonic-screwdriver.cloud](http://sonic-screwdriver.cloud) for full documentation.
 
 ## Why Sonic Was Created
 
-After I exhaust debugging an ECS service with CloudWatch Logs I usually take it to 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.
+After I exhaust debugging an ECS service with CloudWatch Logs, I usually take it to 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.
 
-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:
+To find the instance with the service's docker container I click around on the ECS console website until I locate the container instance's DNS name and then paste it into the terminal. While this process is not complicated, 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
+4. Click on 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
@@ -24,23 +26,23 @@ In order to find the instance with the service's docker container I click around
 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 mental energy clicking on links and use it to focus on better things like fixing the **actual** issue.
+By the time I get into the container, I need to remind my brain of what the original issue was.  This tool automates the 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.
 
 ## Install
 
-If you want to quickly install sonic without having to worry about sonic's dependencies you can simply install the Bolts Toolbelt which has sonic included.
+You can install sonic with RubyGems
 
 ```sh
-brew cask install boltopslabs/software/bolts
+gem install sonic
 ```
 
-Or if you prefer you can install ufo with RubyGems
+If you want to quickly install sonic without having to worry about sonic's dependencies you can also install the Bolts Toolbelt which has sonic included.
 
 ```sh
-gem install ufo
+brew cask install boltopslabs/software/bolts
 ```
 
-Full installation instructions are at [Install Sonic Screwdriver](http://localhost:4000/docs/install/).  There are some server side dependencies for some of the sonic commands so it is important to read through the full installation guide.
+Full installation instructions are at [Install Sonic Screwdriver](http://sonic-screwdriver.cloud/docs/install/).  There are some server side dependencies for some of the sonic commands, so it is important to read through the full installation guide.
 
 ## Quick Start
 
@@ -49,12 +51,16 @@ Here is a quick overview of sonic abilities:
 ```sh
 # ssh into an instance
 sonic ssh i-0f7f833131a51ce35
-sonic ssh hi-web-stag
+sonic ssh hi-web-stag # ec2 tag
+sonic ssh hi-web-stag --cluster stag # ecs service name
+sonic ssh hi-web-stag --cluster stag  # ecs service name
+sonic ssh 7fbc8c75-4675-4d39-a5a4-0395ff8cd474 --cluster stag  # ECS container id
+sonic ssh 1ed12abd-645c-4a05-9acf-739b9d790170 --cluster stag  # ECS task id
 
 # docker exec to a running ECS docker container
 sonic ecs-exec hi-web-stag
 
-# docker run with same environment as the ECS docker running containers
+# docker run with the same environment as the ECS docker running containers
 sonic ecs-run hi-web-stag
 
 # run command on 1 instance
@@ -69,7 +75,7 @@ sonic list hi-web-stag
 
 ## Contributing
 
-Everyone can contribute to make sonic-screwdriver better.  Please fork the project and open a pull request! We love your pull requests. Contributions are encouraged and welcomed!
+Everyone can contribute to making sonic-screwdriver better.  Please fork the project and open a pull request! We love your pull requests. Contributions are encouraged and welcomed!
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/docs/_config.yml

@@ -9,6 +9,7 @@ meta_author: Tung Nguyen
 
 # Google webmaster tools
 google_verify:
+google_analytics: UA-98684555-2
 
 # https://ssl.bing.com/webmaster/configure/verify/ownership Option 2 content= goes here
 bing_verify:
@@ -25,11 +26,11 @@ disqus_shortname:
 
 # Color settings (hex-codes without the leading hash-tag)
 color:
-  primary: 3972c7
+  primary: 47a970
   primary-rgb: "24,288,156" #"128,179,255"
   secondary: 2c3e50 #FD6E8A
   secondary-dark: 233140 #A2122F
-  links: a3c8ff
+  links: 3fda78
 
 # Footer settings
 footer:

data/docs/_docs/install-bastion.md

@@ -7,10 +7,21 @@ It is common to secure your network setup by restricting access to your servers
 You can configure the [settings.yml]({% link _docs/settings.md %}) file to use a bastion host. Here's an example:
 
 ```yaml
-bastion: bastion.mydomain.com
+bastion: # cluster_host mapping
+  default: ec2-user@bastion.mydomain.com
+  prod: ec2-user@bastion.mydomain.com
+  stag: ubuntu@bastion-stag.mydomain.com
 ```
 
-This directs the `sonic ssh` to jump through the bastion host. This works completely transparently. The sonic commands are exactly the same as if there is no bastion host.
+The configuration specifies a bastion for the specific clusters. If the cluster is not in the configuration it defaults to the default bastion host setting.
+
+```sh
+sonic ssh --cluster prod [IDENTIFER] # ec2-user@bastion.mydomain.com used as the bastion host
+sonic ssh --cluster stag [IDENTIFER] # ubuntu@bastion-stag.mydomain.com used as the bastion host
+sonic ssh --cluster whatever [IDENTIFER] # ec2-user@bastion.mydomain.com used as the bastion host
+```
+
+The settting directs the `sonic ssh` to jump through the bastion host. This works completely transparently. The sonic commands are exactly the same as if there is no bastion host. Examples:
 
 ```
 sonic ssh i-0f7f833131a51ce35

data/docs/_docs/install.md

@@ -2,35 +2,37 @@
 title: Installation
 ---
 
-### Install with Bolts Toolbelt
-
-If you want to quickly install sonic without having to worry about sonic's dependency you can simply install the Bolts Toolbelt which has sonic included.
-
-```sh
-brew cask install boltopslabs/software/bolts
-```
-
-For more information about the Bolts Toolbelt or to get an installer for another operating system visit: [https://boltops.com/toolbelt](https://boltops.com/toolbelt)
-
 ### Install with RubyGems
 
-If you prefer to install sonic via RubyGems follow the instructions:
+If can install sonic via RubyGems:
 
 ```sh
 gem install sonic-screwdriver
 ```
 
-Or you can add sonic to your Gemfile in your project if you are working with a ruby project.  It is not required for your project to be a ruby project to use sonic.
+You can also add sonic to your Gemfile in your project if you are working with a ruby project.  It is not required for your project to be a ruby project to use sonic.
 
 ```ruby
 gem "sonic-screwdriver"
 ```
 
+### Install with Bolts Toolbelt
+
+If you want to install sonic without having to worry about sonic's ruby dependency you can simply install the Bolts Toolbelt which has sonic included.
+
+```sh
+brew cask install boltopslabs/software/bolts
+```
+
+For more information about the Bolts Toolbelt or to get an installer for another operating system visit: [https://boltops.com/toolbelt](https://boltops.com/toolbelt)
+
 ### Server Side Dependencies
 
+For a small set of the commands there are server side dependencies.
+
 #### sonic ecs-* dependencies
 
-In order for the `sonic ecs-*` commands to work `jq` is required on the server side. This is covered in the [How It Works]({% link _docs/how-it-works.md %}) section.
+For the `sonic ecs-*` commands to work `jq` is required on the server side. This is covered in the [How It Works]({% link _docs/how-it-works.md %}) section.
 
 One way to install `jq` quickly is by using the `sonic execute` command.  For example:
 
@@ -46,15 +48,15 @@ The `sonic execute` works alongside [Amazon EC2 Run Command](https://aws.amazon.
 
 #### Amazon EC2 Run Manager Installation
 
-Installing the EC2 Run Manager agent on your linux servers is super simple and is only one command.
+Installing the EC2 Run Manager agent on your Linux servers is super simple and is only one command.
 
 ```sh
 sudo yum install -y https://s3.amazonaws.com/ec2-downloads-windows/SSMAgent/latest/linux_amd64/amazon-ssm-agent.rpm
 ```
 
-The full recommended instructions are on the offical Amazon EC2 Systems Manager [Install SSM Agent](http://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-agent.html) documentation.
+The full recommended instructions are on the official Amazon EC2 Systems Manager [Install SSM Agent](http://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-agent.html) documentation.
 
-The trickest part of installing is likely making sure that the agent on the server has successfully checked into the SSM service.  Verify it by tailing `/var/log/amazon/ssm/errors/errors.log`.
+The trickiest part of installing is likely making sure that the agent on the server has successfully checked into the SSM service.  Verify it by tailing `/var/log/amazon/ssm/errors/errors.log`.
 
 If you are having issues, it is most likely IAM issues.  Amazon also provides [Configuring Security Roles](http://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-access.html) docs to fix any IAM issues.
 

data/docs/_docs/next-steps.md

@@ -6,8 +6,9 @@ This concludes the tutorial guide for sonic. Hopefully you are now more comforta
 
 From here, there are a few resources that can help you continue along:
 
+* Jump in the Chat Channel [![Gitter](https://badges.gitter.im/boltopslabs/sonic.svg)](https://gitter.im/boltopslabs/sonic)
 * Check out the [sonic](https://github.com/boltopslabs/sonic) repo on GitHub
-* Submit an issue
+* Submit an [issue](https://github.com/boltopslabs/sonic/issues)
 * Write a blog post describing how you are using sonic, or an interesting problem sonic has allowed you to solve
 
 Everyone can contribute to make sonic better, including the documentation. These docs are of the same sonic repo in the [docs folder](https://github.com/boltopslabs/sonic/tree/master/docs). Please fork the project and open a pull request!  We love your pull requests. Contributions are encouraged and welcomed!

data/docs/_docs/tutorial-ssh.md

@@ -4,19 +4,19 @@ title: SSH
 
 ### SSH
 
-Sonic allows you to quickly ssh into an instance.
+Sonic allows you to ssh into an instance quickly.
 
-Often times when working with AWS EC2 it is helpful to ssh into an instance to debug.  In order to ssh into an instance the first thing you do is go to the EC2 Console and grab the public ip address.
+Often when working with AWS EC2 it is helpful to ssh into an instance to debug.  To ssh into an instance, the first thing you do is go to the EC2 Console and grab the public IP address.
 
 <img src="/img/tutorials/ec2-console-public-ip.png" class="doc-photo" />
 
-You use that ip address to build up an ssh command for accessing the instance.  Here's an example of the built up ssh command.
+You use that IP address to build up an ssh command for accessing the instance.  Here's an example of the built-up ssh command.
 
 ```sh
 ssh ec2-user@52.24.216.170
 ```
 
-You often have to go through this manual process of identifying the public ip address and building up the ssh command repeatedly.
+You often have to go through this manual process of identifying the public IP address and building up the ssh command repeatedly.
 
 ### Usage
 
@@ -26,19 +26,19 @@ Sonic automatically builds up the ssh command for you. Here's an example of the
 sonic ssh i-027363802c6ff314f
 ```
 
-The above command effectively translate to:
+The above command effectively translates to:
 
 ```sh
 ssh ec2-user@52.24.216.170
 ```
 
-By default the user that sonic uses to login to the server is `ec2-user`. This can easily be overriden:
+By default the user that sonic uses to log in to the server is `ec2-user`. You can override the user easily like so:
 
 ```sh
 sonic ssh ubuntu@i-0f7f833131a51ce35
 ```
 
-The default user can also be configure with a `~/.sonic/settings.yml` or the project's `.sonic/settings.yml` file like so:
+The default user can also be configured with a `~/.sonic/settings.yml` or the project's `.sonic/settings.yml` file like so:
 
 ```yaml
 user: ec2-user
@@ -48,9 +48,9 @@ More information about sonic settings in available in the docs: [Settings]({% li
 
 ### Polymorphic Identifiers
 
-The `sonic ssh` command can auto-detect the proper ip address with a variety of different identifiers.  The identifier is not just limited to the instance id. The identifier can be also an EC2 tag-value filter, ECS service name, ECS container id or ECS task id.
+The `sonic ssh` command can auto-detect the proper IP address with a variety of different identifiers.  The identifier is not just limited to the instance id. The identifier can also be an EC2 tag-value filter, ECS service name, ECS container id or ECS task id.
 
-This is convenient in case you happen to be on a dashboard with another identifer close by and handy.  Here are example usage with identifiers that `sonic ssh` understands.
+Polymorphic identifiers are convenient in case you happen to be on a dashboard with another identifier close by and handy.  Here are examples of identifiers that `sonic ssh` understands.
 
 ```
 sonic ssh EC2_TAG_FILTER
@@ -74,7 +74,7 @@ service_cluster:
   hi-worker-stag: stag
 ```
 
-With these settings in place, the ECS identifier commands get shorten to become:
+With these settings in place, the ECS identifier commands get shortened to become:
 
 ```sh
 sonic ssh ECS_CONTAINER_ID
@@ -82,7 +82,7 @@ sonic ssh ECS_SERVICE
 sonic ssh ECS_TASK_ID
 ```
 
-It then becomes very easy to ssh into an EC2 Container Instance with the ECS service name.  For example if the ECS service name is `hi-web-stag` then the command becomes.
+It then becomes effortless to ssh into an EC2 Container Instance with the ECS service name.  For example, if the ECS service name is `hi-web-stag` then the command becomes.
 
 ```sh
 $ sonic ssh hi-web-stag
@@ -91,7 +91,7 @@ $ docker ps
 $ curl -s http://localhost:51678/v1/meta | jq .
 ```
 
-The `hi-web-stag` can possibly be running 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.
+The `hi-web-stag` can be running on multiple container instances.  The `sonic ssh` command chooses the first container instance that it finds.  If you need to ssh into a specific container instance, then use the `sonic ssh` command with an instance id instead.
 
 You can also use the ECS container instance arn or task id to ssh into the machine.  Examples:
 
@@ -102,10 +102,30 @@ $ sonic ssh 1ed12abd-645c-4a05-9acf-739b9d790170 # ECS task id
 
 ### Bastion Host
 
-Thus far we have assumed that the instances we are hopping into are publicly available on a public subnet and have an public ip address associate with it.  A common AWS setup is to have your servers on internal subnets without public addresses.  In this case we must first ssh into the bastion host and from there we can "jump" into the actually server.  This why the bastion host is also called a jump host.
+Thus far we have assumed that the instances we are hopping into are publicly available on a public subnet and have a public IP address associated with it.  A typical AWS setup is to have your servers on internal subnets without public addresses.  In this case, we must first ssh into the bastion host, and from there we can "jump" into the actual server.  This why the bastion host is also called a jump host.
 
-If you have an bastion host server which provides access to your internal servers then it is even more work to build up the ssh command.  The good news is that the `sonic ssh` command supports bastion hosts and automates this process! The [Bastion Setup]({% link _docs/install-bastion.md %}) doc covers how to set this up.
+If you have a bastion host server which provides access to your internal servers, then it is, even more, work to build up the ssh command.  The good news is that the `sonic ssh` command supports bastion hosts and automates this process! The [Bastion Setup]({% link _docs/install-bastion.md %}) doc covers how to set this up.
 
+### Automatic Retry
+
+On a freshly launched EC2 instance, the instance and ssh daemon take a little time before it's ready.  Typically, you repeatedly press up and enter until you can access the server.  Sonic ssh has a `-r` option which automates this process.  Example:
+
+```
+$ sonic ssh -r i-0b21da68fff89937b
+Can't ssh into the server yet.  Retrying until success.
+....
+=> ssh -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -At ec2-user@34.214.143.125
+[ec2-user@ip-10-11-35-76 ~]$
+```
+
+### Specifying Custom Pem or Private Keys
+
+It is recommended that you use ssh-agent to specify a custom private key, covered here [3 SSH tips: Ssh-agent, Tunnel, and Escaping from the Dead](https://blog.boltops.com/2017/09/21/3-ssh-tips-ssh-agent-tunnel-and-escaping-from-the-dead).  You can specify the private key if you prefer with the `-i` option though.  Example:
+
+```sh
+$ sonic ssh -i ~/.ssh/id_rsa-custom i-0b21da68fff89937b
+[ec2-user@ip-10-11-35-76 ~]$
+```
 
 <a id="prev" class="btn btn-basic" href="{% link _docs/tutorial.md %}">Back</a>
 <a id="next" class="btn btn-primary" href="{% link _docs/tutorial-ecs-exec.md %}">Next Step</a>

data/docs/_docs/why-ec2-run-command.md

@@ -6,7 +6,7 @@ Why use Amazon EC2 Run Command vs just using a multi-ssh session?
 
 * Some times it is not possible to use ssh across several servers.  For example, really secured networks might have [MFA setup](TODO) so you need to authorized the requests via your phone before the command actually gets ran. In this case, you would get annoying confirmation notifications on your phone over and over as you approve each request for each of your servers.
 * EC2 Run Command provides auditability. Any command that runs the EC2 Run Command gets logged and is tracked.
-* The EC2 Run Manager has the ability to run the command in "blue/green" fashion with concurrency controls. Say you have 100 servers, you can tell EC2 Run Manager to run the command on one server first and the expodentially roll it out to the rest of the servers until the command has successfully ran on all servers.  If it the command errors then it execute can be told to halt.
+* The EC2 Run Manager has the ability to run the command in "blue/green" fashion with concurrency controls. Say you have 100 servers, you can tell EC2 Run Manager to run the command on one server first and the expodentially roll it out to the rest of the servers until the command has successfully ran on all servers.  If it the command errors on one server then it halts execution and does not run on the rest of the servers.
 * This is all provided for free by using EC2 Run Manager.
 
 The iniitial ertia of setting up EC2 Run Manager is actually very little.  The [installation instructions]({% link _docs/install.md %}) demonstrate that installing EC2 Run Manager is literally one command.

data/docs/_includes/css/sonic.css

@@ -19,6 +19,11 @@ section#main img {
     margin: 0 auto 20px;
 }
 
+section#main li img {
+    display: inline;
+    margin: 0;
+}
+
 section#main .intro-text .name {
     display: block;
     text-transform: uppercase;
@@ -78,7 +83,7 @@ section#main .intro-text .skills {
 }
 
 .content-nav a {
-    color: #9acfe0;
+    color: #54ff9c;
 }
 
 .content-nav a.active {
@@ -112,8 +117,6 @@ ul.tools li {
     font-size: 1.3em;
 }
 
-
-
 .btn-xl {
     padding: 20px 40px;
     border-color: #{{ site.data.template.color.primary }};

data/docs/_includes/google_analytics.html

@@ -0,0 +1,10 @@
+<!-- Google analytics -->
+<script>
+  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+  })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
+
+  ga('create', '{{ site.google_analytics }}', 'auto');
+  ga('send', 'pageview');
+</script>

data/docs/_includes/header.html

@@ -3,7 +3,7 @@
         <div class="container">
             <div class="row">
                 <div class="col-lg-12">
-                    <img class="img-responsive" src="/img/sonic-screwdriver.jpg" alt="">
+                    <img class="img-responsive" src="/img/sonic-logo.png" alt="">
                     <div class="intro-text">
                         <span class="name">{{ site.title }}</span>
                         <hr class="star-light">

data/docs/_includes/js.html

@@ -26,3 +26,7 @@
     {% endif %}
 
     <script src="{{ "/js/nav.js" }}"></script>
+
+    {% if site.google_analytics and jekyll.environment == "production" %}
+    {% include google_analytics.html %}
+    {% endif %}

data/docs/_includes/nav.html

@@ -9,7 +9,7 @@
                     <span class="icon-bar"></span>
                     <span class="icon-bar"></span>
                 </button>
-                <a class="navbar-brand" href="/#page-top"><img class="navbar-logo" src="/img/logos/boltops-logo.png" />{{ site.title }}</a>
+                <a class="navbar-brand" href="/#page-top"><img class="navbar-logo" src="/img/sonic-logo.png" />{{ site.title }}</a>
             </div>
 
             <!-- Collect the nav links, forms, and other content for toggling -->

data/docs/bin/web

@@ -0,0 +1,4 @@
+#!/bin/bash -ex
+
+bundle exec jekyll clean
+exec bundle exec jekyll serve

data/docs/docs.md

@@ -4,7 +4,7 @@ title: Docs
 
 ### Overview
 
-Sonic Screwdriver is a multi-functional tool to manage AWS infrastructure.  It contains a variety of commands to make your job easier. It's main focus is to automate mundane repetitive tasks into simple one line commmands. With it you are to able debug environments and issues much more quickly.
+Sonic Screwdriver is a multi-functional tool to manage AWS infrastructure.  It contains a variety of commands to make your job easier. It's main focus is to automate mundane repetitive tasks into simple one line commmands. With it you are to able debug environments and issues quickly.
 
 The actually command that Sonic Screwdriver provides is called `sonic`.  Here's a list of things that `sonic` can do:
 

data/docs/quick-start.md

@@ -37,7 +37,7 @@ sonic execute hi-web-stag,hi-worker-stag uptime
 sonic list hi-web-stag
 ```
 
-Congratulations! You now know the basics sonic screwdriver commands.
+Congratulations! You now know the basic sonic screwdriver commands now.
 
 Learn more in the next sections.
 

data/lib/sonic/cli.rb

@@ -11,6 +11,8 @@ module Sonic
 
     desc "ssh [IDENTIFER]", "ssh into a instance using identifier. identifer can be several things: instance id, ec2 tag, ECS service name, etc"
     long_desc Help.ssh
+    method_option :keys, :aliases => '-i', :desc => "comma separated list of ssh private key paths"
+    method_option :retry, :aliases => '-r', :type => :boolean, :desc => "keep retrying the server login until successful. Useful when on newly launched instances."
     def ssh(identifier, *command)
       Ssh.new(identifier, options.merge(command: command)).run
     end

data/lib/sonic/cli/help.rb

@@ -48,6 +48,20 @@ $ sonic ssh i-027363802c6ff314f uptime
 => ssh ec2-user@ec2-52-24-216-170.us-west-2.compute.amazonaws.com uptime
  15:57:02 up 18:21,  0 users,  load average: 0.00, 0.01, 0.00
 
+Specifying pem keys:
+
+The recommended way to specify custom private keys is to use ssh-agent as covered here: https://blog.boltops.com/2017/09/21/3-ssh-tips-ssh-agent-tunnel-and-escaping-from-the-dead
+
+But you can also specify the pem key to use with the -i option.  Example:
+
+$ sonic ssh -i ~/.ssh/id_rsa-custom ec2-user@ec2-52-24-216-170.us-west-2.compute.amazonaws.com
+
+Retry option:
+
+For newly launched instances, the instance's ssh access might not be quite ready. Typically, you must press up enter repeatedly until the instance is ready.  Sonic ssh has a retry option that automates this. Example:
+
+$ sonic ssh -r i-027363802c6ff314f
+
 Bastion Host Support
 
 Sonic ssh also supports a bastion host.

data/lib/sonic/execute.rb

@@ -1,4 +1,3 @@
-require "byebug"
 module Sonic
   class Execute
     include AwsServices
@@ -150,11 +149,11 @@ You can use the following command to check registered instances to SSM.
       # it right through
       instances = List.new(@options).instances
       if instances.count == 0
-        message = <<~EOL
-          Unable to find any instances with filter #{@filter.join(',')}.
-          Are you sure you specify the filter with either a EC2 tag or list instance ids?
-          If you are using ECS identifiers, they are not supported with this command.
-        EOL
+        message = <<-EOL
+  Unable to find any instances with filter #{@filter.join(',')}.
+  Are you sure you specify the filter with either a EC2 tag or list instance ids?
+  If you are using ECS identifiers, they are not supported with this command.
+EOL
         UI.warn(message)
       end
       instances.count

data/lib/sonic/settings.rb

@@ -96,9 +96,10 @@ module Sonic
       data
     end
 
+    # By default bypass strict host key checking for convenience.
+    # But user can overrride this.
     def host_key_check_options
-      if data["host_key_check"]
-        # no options by default enables strict host key checking
+      if data["host_key_check"] == true
         []
       else
         # disables host key checking

data/lib/sonic/ssh.rb

@@ -3,8 +3,10 @@ require 'colorize'
 module Sonic
   class Ssh
     autoload :IdentifierDetector, 'sonic/ssh/identifier_detector'
+    autoload :CliOptions, 'sonic/ssh/cli_options'
 
     include AwsServices
+    include CliOptions
 
     def initialize(identifier, options)
       @options = options
@@ -21,6 +23,7 @@ module Sonic
 
     def run
       ssh = build_ssh_command
+      retry_until_success(*ssh) if @options[:retry]
       kernel_exec(*ssh) # must splat the Array here
     end
 
@@ -84,8 +87,11 @@ private
     end
 
     # Returns Array of flags.
+    # Example:
+    #   ["-o", "StrictHostKeyChecking=no", "-o", "UserKnownHostsFile=/dev/null"]
     def ssh_options
-      settings.host_key_check_options
+      host_key_check_options = settings.host_key_check_options
+      keys_option + host_key_check_options
     end
 
     # Will prepend the bastion host if required
@@ -134,5 +140,20 @@ private
         [nil, identifier]
       end
     end
+
+    def retry_until_success(*command)
+      retries = 0
+      uptime = command + ['uptime', '2>&1']
+      uptime = uptime.join(' ')
+      out = `#{uptime}`
+      while out !~ /load average/ do
+        puts "Can't ssh into the server yet.  Retrying until success." if retries == 0
+        print '.'
+        retries += 1
+        sleep 1
+        out = `#{uptime}`
+      end
+      puts "" if @options[:retry] && retries > 0
+    end
   end
 end

data/lib/sonic/ssh/cli_options.rb

@@ -0,0 +1,9 @@
+module Sonic
+  # Processes the sonic ssh options
+  module Ssh::CliOptions
+    def keys_option
+      keys = @options[:keys] || ''
+      keys.split(',').map! {|x| ["-i", x.sub(/^~/,ENV['HOME'])] }.flatten
+    end
+  end
+end

data/lib/sonic/version.rb

@@ -1,3 +1,3 @@
 module Sonic
-  VERSION = "1.3.0"
+  VERSION = "1.3.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sonic-screwdriver
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.2
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-23 00:00:00.000000000 Z
+date: 2017-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -161,6 +161,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
 - Guardfile
@@ -204,6 +205,7 @@ files:
 - docs/_includes/edit-on-github.html
 - docs/_includes/example.html
 - docs/_includes/footer.html
+- docs/_includes/google_analytics.html
 - docs/_includes/head.html
 - docs/_includes/header.html
 - docs/_includes/js.html
@@ -217,6 +219,7 @@ files:
 - docs/_layouts/default.html
 - docs/_layouts/style.css
 - docs/articles.md
+- docs/bin/web
 - docs/css/font-awesome/css/font-awesome.css
 - docs/css/font-awesome/css/font-awesome.min.css
 - docs/css/font-awesome/fonts/FontAwesome.otf
@@ -227,10 +230,9 @@ files:
 - docs/docs.md
 - docs/img/logos/boltops-logo-full.png
 - docs/img/logos/boltops-logo.png
-- docs/img/sonic-screwdriver.jpg
+- docs/img/sonic-logo.png
 - docs/img/tutorials/ec2-console-public-ip.png
 - docs/img/tutorials/ec2-console-run-command.png
-- docs/img/ufo.jpg
 - docs/index.html
 - docs/js/bootstrap.js
 - docs/js/bootstrap.min.js
@@ -260,6 +262,7 @@ files:
 - lib/sonic/list.rb
 - lib/sonic/settings.rb
 - lib/sonic/ssh.rb
+- lib/sonic/ssh/cli_options.rb
 - lib/sonic/ssh/ec2_tag.rb
 - lib/sonic/ssh/identifier_detector.rb
 - lib/sonic/ui.rb