sonic-screwdriver 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9fcf3cedf767fb24e46f926676e90e6665a16b7e
-  data.tar.gz: 61a4e4f685b0ebff993ade25c55d0c790f440d2a
+  metadata.gz: bab148a2ed5638be1af0462d0e8d8e594bb17b8b
+  data.tar.gz: ab33bc905251629ebfe0afb313b1467652ec14f5
 SHA512:
-  metadata.gz: 70c990f11c3d1bd7f6ddf3d2ed1d2f4156c7dde78601e3964d28e73fe9eff41f0f70d5280910793d9250e78eefef16a46d39e1f544d64d3b1a8d0bd913e480df
-  data.tar.gz: 896df9f8754358469a65376534b564950314e751a3a1c21634c30d0e640f789a295854d46233fd661e2b54735b8a939cfd341772deccfea0e66022f2c4c9a6b9
+  metadata.gz: 448ee390aeaf1d33395515f30d0a7aafd1347a6c8cf07230325441cd4a38027f7d3eb0a7dd361d0698b96a4a36088a0eadc8631050c56e303bac017dd6efc7f1
+  data.tar.gz: 5f346a3756cd24f8025eafd1ac227fc075d3f9948164ba076544f7bafb7905a5a35e01d3cad32d3a5a991605f456da72dec052ad11b93ce6f4acaeb6801b337a

data/CHANGELOG.md

@@ -3,6 +3,10 @@
 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.2.0]
+- add old instance id support
+- update docs and help
+
 ## [1.1.1]
 - update docs and help
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sonic-screwdriver (0.0.1)
+    sonic-screwdriver (1.1.1)
       aws-sdk
       colorize
       hashie
@@ -11,13 +11,13 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    aws-sdk (2.9.42)
-      aws-sdk-resources (= 2.9.42)
-    aws-sdk-core (2.9.42)
+    aws-sdk (2.9.43)
+      aws-sdk-resources (= 2.9.43)
+    aws-sdk-core (2.9.43)
       aws-sigv4 (~> 1.0)
       jmespath (~> 1.0)
-    aws-sdk-resources (2.9.42)
-      aws-sdk-core (= 2.9.42)
+    aws-sdk-resources (2.9.43)
+      aws-sdk-core (= 2.9.43)
     aws-sigv4 (1.0.0)
     codeclimate-test-reporter (1.0.8)
       simplecov (<= 0.13)

data/README.md

@@ -1,4 +1,4 @@
-# Sonic
+# Sonic Screwdriver
 
 [![CircleCI](https://circleci.com/gh/boltopslabs/sonic.svg?style=svg)](https://circleci.com/gh/boltopslabs/sonic)
 
@@ -69,6 +69,8 @@ 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!
+
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)

data/docs/_docs/settings.md

@@ -4,7 +4,7 @@ title: Settings
 
 You can adjust the behavior of sonic and set some handy default values with `settings.yml` files.  There can exist multiple settings files which all get loaded and merged. The options from the files follow the following precedence rules:
 
-1. project - The project's `.sonic/settings.yml` values take the highest precedence.
+1. current folder - The current folder's `.sonic/settings.yml` values take the highest precedence. The current folder is typically the project folder.
 2. user - The user's `~/.sonic/settings.yml` values take the second highest precedence.
 3. default - The [default settings](https://github.com/boltopslabs/sonic/blob/master/lib/sonic/default/settings.yml) bundled with the tool takes the lowest precedence.
 

data/docs/_docs/tutorial-ecs-exec.md

@@ -33,6 +33,8 @@ root@fc4035f90bdc:/app#
 
 What you see in the last line above is a bash prompt because you are in a bash shell within the docker container!  Ultimately sonic runs runs a `docker exec -ti ECS_SERVICE_CONTAINER bash` after ssh-ing into the instance.  With one command you have placed yourself into the running container 🎉
 
+### Possibilities
+
 Here are examples to show what is possible:
 
 ```
@@ -59,7 +61,7 @@ sonic ecs-exec 9f1dadc7-4f67-41da-abec-ec08810bfbc9 bash
 sonic ecs-exec i-006a097bb10643e20 bash
 ```
 
-### Settings - service_cluster
+### Settings - service_cluster mapping
 
 As mentioned in the [previous section]({% link _docs/tutorial-ssh.md %}) and also in the [Settings documentation]({% link _docs/settings.md %}) you can configure a `~/.sonic/settings.yml` file which shortens the command further.  Let's add this to your settings:
 

data/docs/_docs/tutorial-ecs-run.md

@@ -4,9 +4,15 @@ title: ECS Run
 
 The nice thing about the previous `ecs-exec` command we covered is that it allows you to get into the actual running container and debug with the exact environment that is on production.  The cavaet with doing this is that we are affecting a live process in actual use. If you do something inadvertently wrong on the server it could affect users.  Sometimes it is nice to start up a new container with the exact same environment as the other running containers but be isolated so you cannot affect live requests.
 
+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.
+
 ### 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.  Here's an example:
+```sh
+sonic ecs-run [ECS_SERVICE] --cluster [ECS_CLUSTER]
+```
+
+Here's an example:
 
 ```sh
 sonic ecs-run hi-web-stag

data/docs/_docs/tutorial-execute.md

@@ -4,10 +4,20 @@ title: Sonic Execute
 
 ### Run One Liners
 
-Sonic provides a way to execute commands remotely and securely across a list of AWS servers.  It does this by leveraging [Amazon EC2 Run Command](https://aws.amazon.com/ec2/execute/).  Sonic hides any complexity and provides a simple interface for you. Example:
+Sonic provides a way to execute commands remotely and securely across a list of AWS servers.  It does this by leveraging [Amazon EC2 Run Command](https://aws.amazon.com/ec2/execute/).  Sonic hides any complexity and provides a simple interface for you.   The command is called `sonic execute`:
+
+```sh
+sonic execute [FILTER] [COMMAND]
+```
+
+Examples:
 
 ```sh
 sonic execute hi-web-stag uptime
+sonic execute hi-web-prod uptime
+sonic execute hi-web-prod,hi-worker-prod,hi-clock-prod uptime
+sonic execute i-030033c20c54bf149,i-030033c20c54bf150 uname -a
+sonic execute i-030033c20c54bf149 file://hello.sh
 ```
 
 Let's do something more useful:
@@ -30,7 +40,11 @@ The output of the commands ran are also showed in the EC2 Run Command Console.
 
 <img src="/img/tutorials/ec2-console-run-command.png" class="doc-photo" />
 
-You can execute a command with a list of filters seprated by commas. For example, this will run the uptime command on any server with a tag value of hi-web-stag,hi-clock-stag, or hi-worker-stag.
+### Polymorphic Filter
+
+The `sonic execute` command can understand a variety of different filters.  The filters can be a list of instances ids or a list of EC2 tag names. Note, ECS service names are *not* supported for the filter.
+
+Here is an example, where the uptime command will run on any server with a tag value of hi-web-stag,hi-clock-stag, or hi-worker-stag.
 
 ```sh
 sonic execute hi-web-stag,hi-clock-stag,hi-worker-stag uptime
@@ -53,6 +67,13 @@ sonic execute hi-web-stag file://hi.sh
 
 The file gets read by `sonic execute` and sent to EC2 Run Command to be executed.
 
+### Amazon EC2 Run Manager Installation
+
+The `sonic execute` command relies on EC2 Run Manager. So you will need to have EC2 Run Manager installed on the servers where you want to the commands to be executed.
+
+* You can follow the [installation guide]({% link _docs/install.md %}) to install EC2 Run Manager.
+* You can read on [Why EC2 Run Manager]({% link _docs/why-ec2-run-command.md %}) is used also.
+
 <a id="prev" class="btn btn-basic" href="{% link _docs/tutorial-ecs-run.md %}">Back</a>
 <a id="next" class="btn btn-primary" href="{% link _docs/settings.md %}">Next Step</a>
 <p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>

data/docs/_docs/tutorial-ssh.md

@@ -46,17 +46,21 @@ user: ec2-user
 
 More information about sonic settings in available in the docs: [Settings]({% link _docs/settings.md %}).
 
-### Different Identifiers
+### Polymorphic Identifiers
 
-The `sonic ssh` command can auto-detect the proper ip address with a variety of different identifiers.  It is not just limited to the instance id. This is convenient in case you happen to be on a dashboard with another identifer close by and handy.  Here are examples of other identifiers that `sonic ssh` understands.
+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.
+
+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.
 
 ```
 sonic ssh EC2_TAG_FILTER
-sonic ssh ECS_CONTAINER_ID --cluster stag
 sonic ssh ECS_SERVICE --cluster stag
+sonic ssh ECS_CONTAINER_ID --cluster stag
 sonic ssh ECS_TASK_ID --cluster stag
 ```
 
+The EC2 tag filter uses the 'tag-value' filter as described in the [AWS describe-instances](http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html) filter docs. This filter is independent of the tag-key filter, which means any EC2 tag value will match, regardless of the tag key name.  Sonic does not support spaces in the EC2 tag filter.
+
 Notice, that when the `sonic ssh` is passed an ECS identifier then it also requires the ECS cluster name. The commands above with the ECS identifier are normally shorten further by configuring the a [settings]({% link _docs/settings.md %}) file.  Here's an example:
 
 ```yaml

data/docs/quick-start.md

@@ -15,7 +15,11 @@ brew cask install boltopslabs/software/bolts
 ```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

data/lib/sonic/cli.rb

@@ -9,14 +9,12 @@ module Sonic
     class_option :bastion, desc: "Bastion jump host to use.  Defaults to no bastion server."
     class_option :project_root, desc: "Project root. Useful for testing.", hide: true
 
-    stop_on_unknown_option! :ssh
     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
     def ssh(identifier, *command)
       Ssh.new(identifier, options.merge(command: command)).run
     end
 
-    stop_on_unknown_option! :ecs_exec
     desc "ecs-exec [ECS_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)
@@ -24,14 +22,12 @@ module Sonic
     end
 
     # Cannot name the command run because that is a reserved Thor keyword :(
-    stop_on_unknown_option! :ecs_run
     desc "ecs-run [ECS_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
 
-    stop_on_unknown_option! :execute
     desc "execute [FILTER] [COMMAND]", "runs command across fleet of servers via AWS Run Command"
     long_desc Help.execute
     # filter - Filter ec2 instances by tag name or instance_ids separated by commas

data/lib/sonic/cli/help.rb

@@ -24,11 +24,13 @@ Ssh quicky into an EC2 instance using an identifier. The identifier can be many
 * ECS container instance id. Example: 7fbc8c75-4675-4d39-a5a4-0395ff8cd474
 * ECS task id. Example: 1ed12abd-645c-4a05-9acf-739b9d790170
 
+When using ecs identifiers the `--cluster` option is required or can be set in ~/.sonic/settings.yml.
+
 Examples:
 
 $ sonic ssh i-067c5e3f026c1e801
 $ sonic ssh hi-web-prod
-$ sonic ssh --cluster my-cluster my-ecs-service # cluster is required or ~/.sonic/settings.yml
+$ sonic ssh --cluster my-cluster my-ecs-service
 $ sonic ssh 7fbc8c75-4675-4d39-a5a4-0395ff8cd474
 $ sonic ssh 1ed12abd-645c-4a05-9acf-739b9d790170
 
@@ -55,7 +57,7 @@ $ sonic ssh --bastion user@bastion.domain.com i-027363802c6ff314f
 
 Here's what the output looks like:
 
-$ sonic ssh i-0f7f833131a51ce35 --bastion 34.211.223.3 uptime
+$ sonic ssh --bastion 34.211.223.3 i-0f7f833131a51ce35 uptime
 => ssh -At ec2-user@34.211.223.3 ssh ec2-user@10.10.110.135 uptime
  17:57:59 up 37 min,  0 users,  load average: 0.00, 0.02, 0.00
 Connection to 34.211.223.3 closed.
@@ -71,6 +73,8 @@ with the service and docker exec's into it.
 Examples:
 
 $ sonic ecs-exec my-service --cluster my-cluster
+
+You can use a variety of identifiers.  These include the ECS service name and task id.
 EOL
         end
 

data/lib/sonic/execute.rb

@@ -125,7 +125,9 @@ module Sonic
     end
 
     def instance_id?(text)
-      text =~ /i-.{17}/
+      # new format is 17 characters long after i-
+      # old format is 8 characters long after i-
+      text =~ /i-.{17}/ || text =~ /i-.{8}/
     end
   end
 end

data/lib/sonic/list.rb

@@ -29,15 +29,21 @@ module Sonic
       UI.say("No instances found with the filter #{@filter.join('')}") if zero_instances
 
       if @options[:header] && !zero_instances
-        UI.say "Instance Id\tPublic IP\tPrivate IP\tType".colorize(:green)
+        header = ["Instance Id", "Name", "Public IP", "Private IP", "Type"]
+        UI.say header.join("\t").colorize(:green)
       end
 
       instances.each do |i|
-        line = [i.instance_id, i.public_ip_address, i.private_ip_address, i.instance_type].join("\t")
+        line = [i.instance_id, tag_value(i, "Name"), i.public_ip_address, i.private_ip_address, i.instance_type].join("\t")
         UI.say(line)
       end
     end
 
+    def tag_value(instance, key)
+      tag = instance.tags.find { |i| i.key == key }
+      tag.value
+    end
+
     #
     # Public: Transform the filter to the ssm send_command equivalent options
     #

data/lib/sonic/version.rb

@@ -1,3 +1,3 @@
 module Sonic
-  VERSION = "1.1.1"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sonic-screwdriver
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-22 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor