sonic-screwdriver 1.4.0 → 2.0.0

data/docs/_reference/sonic-execute.md

@@ -0,0 +1,84 @@
+---
+title: sonic execute
+reference: true
+---
+
+## Usage
+
+    sonic execute [FILTER] [COMMAND]
+
+## Description
+
+Runs command across fleet of servers via AWS Run Command.
+
+Run as a command across a list of servers. A filter must be provided.  The filter can be a mix of instance ids and ec2 tags. This command can also take a path to a file. To specify a path to a file use file:// at the beginning of your file.
+
+## Examples Summary
+
+    $ 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
+
+You cannot mix instance ids and tag names in the filter.
+
+## Example Detailed
+
+Here's a command example output in detailed:
+
+```sh
+$ sonic execute i-0bf51a000ab4e73a8 uptime
+Sending command to SSM with options:
+---
+instance_ids:
+- i-0bf51a000ab4e73a8
+document_name: AWS-RunShellScript
+comment: sonic execute i-0bf51a000ab4e73a8 uptime
+parameters:
+    commands:
+  - uptime
+output_s3_region: us-east-1
+output_s3_bucket_name: [reacted]
+output_s3_key_prefix: ssm/commands/sonic
+
+Command sent to AWS SSM. To check the details of the command:
+    aws ssm list-commands --command-id 0bb18d58-6436-49fd-9bfd-0c4b6c51c7a2
+    aws ssm get-command-invocation --command-id 0bb18d58-6436-49fd-9bfd-0c4b6c51c7a2 --instance-id i-0bf51a000ab4e73a8
+
+Waiting for ssm command to finish.....
+Command finished.
+
+Displaying output for i-0bf51a000ab4e73a8.
+Command status: Success
+Command standard output:
+ 01:08:10 up 8 days,  6:41,  0 users,  load average: 0.00, 0.00, 0.00
+
+To see the more output details visit:
+    https://us-west-2.console.aws.amazon.com/systems-manager/run-command/0bb18d58-6436-49fd-9bfd-0c4b6c51c7a2
+
+Pro tip: the console url is already in your copy/paste clipboard.
+$
+```
+
+Notice the conveniences of `sonic execute`, it:
+
+1. Showed the parameters that will be sent as part of the send_command call to SSM.
+2. Sent the command to SSM.
+3. Waited for the command to finish.
+4. Displayed the output of the command.
+5. Provided the console url that visit to view more details about the SSM command.
+
+The AWS SSM console looks like this:
+
+<img src="/img/tutorials/ec2-console-run-command.png" class="doc-photo" />
+
+
+## Options
+
+```
+[--zero-warn], [--no-zero-warn]  # Warns user when no instances found
+                                 # Default: true
+[--verbose], [--no-verbose]      
+[--noop], [--no-noop]            
+```
+

data/docs/_reference/sonic-list.md

@@ -0,0 +1,40 @@
+---
+title: sonic list
+reference: true
+---
+
+## Usage
+
+    sonic list [FILTER]
+
+## Description
+
+Lists ec2 instances.
+
+List ec2 servers. A filter must be provided.  The filter can be a mix of instance ids and ec2 tags. sonic list will auto-detect the what type of filter it is filter appropriately.  The filter for listing is optional.
+
+Examples:
+
+    $ sonic list
+    $ sonic list hi-web-prod
+    $ sonic list hi-web-prod,hi-clock-prod
+    $ sonic list i-09482b1a6e330fbf7
+
+Example Output:
+
+    $ sonic list --header i-09482b1a6e330fbf7
+    Instance Id Public IP Private IP  Type
+    i-09482b1a6e330fbf7 54.202.152.168  172.31.21.108 t2.small
+    $
+
+You cannot mix instance ids and tag names in the filter.
+
+
+## Options
+
+```
+[--header], [--no-header]    # Displays header
+[--verbose], [--no-verbose]  
+[--noop], [--no-noop]        
+```
+

data/docs/_reference/sonic-ssh.md

@@ -0,0 +1,86 @@
+---
+title: sonic ssh
+reference: true
+---
+
+## Usage
+
+    sonic ssh [IDENTIFER]
+
+## Description
+
+Ssh into a instance using identifier. identifer can be several things: instance id, ec2 tag, ECS service name, etc.
+
+* EC2 instance id. Example: i-067c5e3f026c1e801
+* EC2 tag value. Any tag value is search, the tag key does not matter only the tag value matters. Example: hi-web
+* 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
+
+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
+    $ sonic ssh --cluster my-cluster my-ecs-service
+    $ sonic ssh 7fbc8c75-4675-4d39-a5a4-0395ff8cd474
+    $ sonic ssh 1ed12abd-645c-4a05-9acf-739b9d790170
+
+Sonic ssh builds up the ssh command and shells out to it. For example, the following commands:
+
+    sonic ssh i-027363802c6ff314f
+
+Translates to:
+
+    ssh ec2-user@ec2-52-24-216-170.us-west-2.compute.amazonaws.com
+
+You can also tack on any command to be run at the end of the command. Example:
+
+    $ 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.
+
+    $ sonic ssh --bastion bastion.domain.com i-027363802c6ff314f
+    $ sonic ssh --bastion user@bastion.domain.com i-027363802c6ff314f
+
+Here's what the output looks like:
+
+    $ 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.
+    $
+
+You can also set the bastion host and other options with a [settings file](http://sonic-screwdriver.cloud/docs/settings/).
+
+
+## Options
+
+```
+-i, [--keys=KEYS]                # comma separated list of ssh private key paths
+-r, [--retry], [--no-retry]      # keep retrying the server login until successful. Useful when on newly launched instances.
+    [--bastion=BASTION]          # Bastion jump host to use.  Defaults to no bastion server.
+    [--cluster=CLUSTER]          # ECS Cluster to use.  Default cluster is default
+    [--verbose], [--no-verbose]  
+    [--noop], [--no-noop]        
+```
+

data/docs/_reference/sonic-version.md

@@ -0,0 +1,21 @@
+---
+title: sonic version
+reference: true
+---
+
+## Usage
+
+    sonic version
+
+## Description
+
+prints version
+
+
+## Options
+
+```
+[--verbose], [--no-verbose]  
+[--noop], [--no-noop]        
+```
+

data/docs/quick-start.md

@@ -15,26 +15,25 @@ gem install sonic-screwdriver
 ```sh
 # ssh into an instance
 sonic ssh i-0f7f833131a51ce35
-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
+sonic ssh hi-web # ec2 tag
+sonic ssh hi-web --cluster staging # ecs service name
+sonic ssh 7fbc8c75-4675-4d39-a5a4-0395ff8cd474 --cluster staging # ECS container id
+sonic ssh 1ed12abd-645c-4a05-9acf-739b9d790170 --cluster staging # ECS task id
 
 # docker exec to a running ECS docker container
-sonic ecs-exec hi-web-stag
+sonic ecs exec hi-web
 
 # docker run with same environment as the ECS docker running containers
-sonic ecs-run hi-web-stag
+sonic ecs sh hi-web
 
 # run command on 1 instance
 sonic execute i-0f7f833131a51ce35 uptime
 
-# run command on all instances tagged with hi-web-stag and worker
-sonic execute hi-web-stag,hi-worker-stag uptime
+# run command on all instances tagged with hi-web and worker
+sonic execute hi-web,hi-worker uptime
 
 # list ec2 instances
-sonic list hi-web-stag
+sonic list hi-web
 ```
 
 Congratulations! You now know the basic sonic screwdriver commands now.

data/docs/reference.md

@@ -0,0 +1,12 @@
+---
+title: CLI Reference
+---
+{% include reference.md %}
+
+* [sonic completion]({% link _reference/sonic-completion.md %})
+* [sonic completion_script]({% link _reference/sonic-completion_script.md %})
+* [sonic ecs]({% link _reference/sonic-ecs.md %})
+* [sonic execute]({% link _reference/sonic-execute.md %})
+* [sonic list]({% link _reference/sonic-list.md %})
+* [sonic ssh]({% link _reference/sonic-ssh.md %})
+* [sonic version]({% link _reference/sonic-version.md %})

data/{bin → exe}/sonic

@@ -7,8 +7,8 @@ Signal.trap("INT") {
   exit
 }
 
-$:.unshift(File.expand_path('../../lib', __FILE__))
-require 'sonic'
-require 'sonic/cli'
+$:.unshift(File.expand_path("../../lib", __FILE__))
+require "sonic"
+require "sonic/cli"
 
 Sonic::CLI.start(ARGV)

data/lib/bash_scripts/docker-exec.sh

@@ -12,4 +12,5 @@ else
   COMMAND=bash
 fi
 
+set -x
 exec docker exec -ti $CONTAINER_ID $COMMAND

data/lib/bash_scripts/docker-run.sh

@@ -12,4 +12,11 @@ CONTAINER_IMAGE=$(cat /tmp/sonic/docker-image.txt)
 cp /tmp/sonic/env-file.txt ~/
 rm -rf /tmp/sonic
 
-exec docker run -ti --env-file ~/env-file.txt $CONTAINER_IMAGE "$@"
+if [ $# -eq 0 ]; then
+  COMMAND=bash
+else
+  COMMAND=$@
+fi
+
+set -x
+exec docker run -ti --env-file ~/env-file.txt "$CONTAINER_IMAGE" $COMMAND

data/lib/sonic.rb

@@ -3,14 +3,22 @@ require "sonic/version"
 require "colorize"
 
 module Sonic
-  autoload :AwsServices, 'sonic/aws_services'
+  autoload :Core, 'sonic/core'
+  autoload :Help, 'sonic/help'
+  autoload :AwsService, 'sonic/aws_service'
   autoload :CLI, 'sonic/cli'
+  autoload :BaseCommand, 'sonic/base_command'
   autoload :Command, 'sonic/command'
   autoload :Docker, 'sonic/docker'
   autoload :Execute, 'sonic/execute'
   autoload :List, 'sonic/list'
-  autoload :Settings, 'sonic/settings'
+  autoload :Setting, 'sonic/setting'
   autoload :Ssh, 'sonic/ssh'
   autoload :UI, 'sonic/ui'
   autoload :Checks, 'sonic/checks'
+  autoload :Completion, "sonic/completion"
+  autoload :Completer, "sonic/completer"
+  autoload :Ecs, "sonic/ecs"
+
+  extend Core
 end

data/lib/sonic/{aws_services.rb → aws_service.rb}

@@ -1,9 +1,10 @@
 require "aws-sdk-ec2"
 require "aws-sdk-ecs"
 require "aws-sdk-ssm"
+require "aws-sdk-s3"
 
 module Sonic
-  module AwsServices
+  module AwsService
     def ecs
       @ecs ||= Aws::ECS::Client.new
     end
@@ -19,5 +20,9 @@ module Sonic
     def ssm
       @ssm ||= Aws::SSM::Client.new
     end
+
+    def s3
+      @s3 ||= Aws::S3::Client.new
+    end
   end
 end

data/lib/sonic/base_command.rb

@@ -0,0 +1,82 @@
+require "thor"
+
+# Override thor's long_desc identation behavior
+# https://github.com/erikhuda/thor/issues/398
+class Thor
+  module Shell
+    class Basic
+      def print_wrapped(message, options = {})
+        message = "\n#{message}" unless message[0] == "\n"
+        stdout.puts message
+      end
+    end
+  end
+end
+
+module Sonic
+  class BaseCommand < Thor
+    class << self
+      def dispatch(m, args, options, config)
+        # Allow calling for help via:
+        #   sonic command help
+        #   sonic command -h
+        #   sonic command --help
+        #   sonic command -D
+        #
+        # as well thor's normal way:
+        #
+        #   sonic help command
+        help_flags = Thor::HELP_MAPPINGS + ["help"]
+        if args.length > 1 && !(args & help_flags).empty?
+          args -= help_flags
+          args.insert(-2, "help")
+        end
+
+        #   sonic version
+        #   sonic --version
+        #   sonic -v
+        version_flags = ["--version", "-v"]
+        if args.length == 1 && !(args & version_flags).empty?
+          args = ["version"]
+        end
+
+        super
+      end
+
+      # Override command_help to include the description at the top of the
+      # long_description.
+      def command_help(shell, command_name)
+        meth = normalize_command_name(command_name)
+        command = all_commands[meth]
+        alter_command_description(command)
+        super
+      end
+
+      def alter_command_description(command)
+        return unless command
+
+        # Add description to beginning of long_description
+        long_desc = if command.long_description
+            "#{command.description}\n\n#{command.long_description}"
+          else
+            command.description
+          end
+
+        # add reference url to end of the long_description
+        unless website.empty?
+          full_command = [command.ancestor_name, command.name].compact.join('-')
+          url = "#{website}/reference/sonic-#{full_command}"
+          long_desc += "\n\nHelp also available at: #{url}"
+        end
+
+        command.long_description = long_desc
+      end
+      private :alter_command_description
+
+      # meant to be overriden
+      def website
+        "http://sonic-screwdriver.cloud"
+      end
+    end
+  end
+end