sonic-screwdriver 2.0.0 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc8cb5fef87d05bf06b47548ad6d943fa90682269ac5493881bee38eb47e2e45
-  data.tar.gz: 7f19894b800b5b042cb86e984d25fa793fe7601f2f35578b76fd8c088edb1790
+  metadata.gz: 58baac92cd0720ee6f66d62b668d53eaf77a9b0bb184241dbbb69bdb2b7b120b
+  data.tar.gz: 593b326eee1fffa6da70b87f133a4cc1a61ae41b465962b5fa9077f1998c4dc5
 SHA512:
-  metadata.gz: 85d9a8a7cd31dc070265d3769f9ca654f34654e89d29d56b90a1772530781ff74d092210ed2479f780c1c8bc456e65ee822b0f1bc9a91d361a6950b6e42966f5
-  data.tar.gz: 8641e4970facbbb88546f9e542f2cc4fd07f4f3008c7c6287284e1e79977323c7865c14df74f5e667c758fbdec81c682743a37560bacb86907e3e2458bf714a6
+  metadata.gz: 01b85739677b31d02caeb2c34a585fc2f711972ff086574b138f68b38ba156e9325dd0f8ba6fb76bd698f5b7bf422b4a1a11336f27b4695d2f2de153688dcc3b
+  data.tar.gz: d42107ab7218aab71cf6b500dc377e34a587b27155e696f729633a870b2788ab0807fc16c680c49083c99597ab466631b5e8f92b7d343a388379f5e2ce918c3c

data/.circleci/config.yml

@@ -7,7 +7,7 @@ jobs:
   build:
     docker:
       # specify the version you desire here
-      - image: circleci/ruby:2.5.1-node-browsers
+      - image: circleci/ruby:2.6.5-node-browsers
 
       # Specify service dependencies here if necessary
       # CircleCI maintains a library of pre-built images
@@ -35,6 +35,8 @@ jobs:
       - run:
           name: install dependencies
           command: |
+            gem install bundler
+            gem update --system
             bundle install --jobs=4 --retry=3 --path vendor/bundle
 
       - save_cache:

data/.gitignore

@@ -14,3 +14,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+Gemfile.lock

data/CHANGELOG.md

@@ -1,7 +1,25 @@
 # 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.
+This project *loosely* adheres to [Semantic Versioning](http://semver.org/), even before v1.0.
+
+## [2.2.2] - 2021-04-12
+- [#11](https://github.com/boltops-tools/sonic/pull/11) cli check
+
+## [2.2.1] - 2021-04-12
+- [#9](https://github.com/boltops-tools/sonic/pull/9) improve command array handling
+
+## [2.2.0]
+- #7 sonic execute command: `--tags` and `--instance-id` options instead of polymorphic list. Breaking behavior.
+- display output even if tags used
+- configure default log group
+- correct exit status
+
+## [2.1.1]
+- use rainbow gem for terminal colors
+
+## [2.1.0]
+- change the setting format to ssh.user instead of bastion.user
 
 ## [2.0.0]
 - Merge pull request #5 from boltopslabs/cli-template-upgrade

data/README.md

@@ -4,6 +4,8 @@
 [![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)
 
+[![BoltOps Badge](https://img.boltops.com/boltops/badges/boltops-badge.png)](https://www.boltops.com)
+
 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.
@@ -32,15 +34,7 @@ By the time I get into the container, I need to remind my brain of what the orig
 
 You can install sonic with RubyGems
 
-```sh
-gem install sonic
-```
-
-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
-brew cask install boltopslabs/software/bolts
-```
+    gem install sonic
 
 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.
 
@@ -48,30 +42,33 @@ Full installation instructions are at [Install Sonic Screwdriver](http://sonic-s
 
 Here is a quick overview of sonic abilities:
 
-```sh
-# ssh into an instance
-sonic ssh i-0f7f833131a51ce35
-sonic ssh hi-web # ec2 tag
-sonic ssh hi-web --cluster staging # ecs service name
-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
+    # ssh into an instance
+    sonic ssh i-0f7f833131a51ce35
+    sonic ssh demo-web # ec2 tag
+    sonic ssh demo-web --cluster staging # ecs service name
+    sonic ssh demo-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 demo-web
 
-# docker exec to a running ECS docker container
-sonic ecs exec hi-web
+    # docker run with the same environment as the ECS docker running containers
+    sonic ecs sh demo-web
 
-# docker run with the same environment as the ECS docker running containers
-sonic ecs sh hi-web
+    # run command with instance ids
+    sonic execute --instance-ids i-111 uptime
+    sonic execute --instance-ids i-111,i-222 uptime
 
-# run command on 1 instance
-sonic execute i-0f7f833131a51ce35 uptime
+    # run command on all instances tagged with Name demo-web and worker
+    sonic execute --tags Name=demo-web,demo-worker uptime
 
-# run command on all instances tagged with hi-web and worker
-sonic execute hi-web,hi-worker uptime
+    # run command on all instances with multiple tags
+    # Quotes are important due to semi-colon
+    sonic execute --tags "Name=demo-web,demo-worker;Owner=test" uptime
 
-# list ec2 instances
-sonic list hi-web
-```
+    # list ec2 instances
+    sonic list demo-web
 
 ## Contributing
 

data/docs/_docs/install.md

@@ -16,16 +16,6 @@ You can also add sonic to your Gemfile in your project if you are working with a
 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.

data/docs/_docs/next-steps.md

@@ -14,6 +14,6 @@ From here, there are a few resources that can help you continue along:
 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!
 
 <a id="prev" class="btn btn-basic" href="{% link _docs/how-it-works.md %}">Back</a>
-<!-- <a id="next" class="btn btn-primary" href="{% link articles.md %}">Next Step</a> -->
+<a id="next" class="btn btn-primary" href="{% link reference.md %}">Next Step</a>
 <p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>
 

data/docs/_docs/settings.md

@@ -23,10 +23,12 @@ Here is an `prod-profile.yml` example:
 
 ```yaml
 bastion: # cluster_host mapping
-  user: ec2-user
   host: # default is nil - which means a bastion host wont be used
   host_key_check: false
 
+ssh:
+  user: ec2-user
+
 # used with `sonic ecs ssh` command
 ecs_service_cluster_map:
   default: default # default cluster
@@ -39,10 +41,10 @@ The following table covers the different setting options:
 
 Setting  | Description | Default
 ------------- | ------------- | -------------
-bastion.user  | User to ssh into the server with. This can be overriden at the CLI with the user@host notation but can be set in the settings.yml file also. | ec2-user
 bastion.host  | Bastion mapping allows you to set a bastion host on a per ECS cluster basis.  The bastion host is used as the jump host. Examples: bastion.mydomain.com, myuser@bastion.myuser.com or 123.123.123.123. | (no value)
 bastion.host_key_check  | Controls whether or not use the strict host checking ssh option.  Since EC2 server host changes often the default value is false. | false
 ecs_service_cluster_map  | Service to cluster mapping.  This is a Hash structure that maps the service name to cluster names. | (no value)
+ssh.user  | User to ssh into the server with. This can be overriden at the CLI with the user@host notation but can be set in the settings.yml file also. | ec2-user
 
 The default settings are located tool source code at [lib/sonic/default/settings.yml](https://github.com/boltopslabs/sonic/blob/master/lib/sonic/default/settings.yml).
 

data/docs/_docs/tutorial-execute.md

@@ -6,56 +6,50 @@ title: Sonic Execute
 
 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 a simple interface and some conveniences for you.   The command is called `sonic execute`:
 
-```sh
-sonic execute [FILTER] [COMMAND]
-```
+    sonic execute [FILTER] [COMMAND]
 
 ## Examples Summary
 
-```sh
-sonic execute hi-web uptime
-sonic execute hi-web-prod uptime
-sonic execute i-030033c20c54bf149,i-030033c20c54bf150 uname -a
-sonic execute i-030033c20c54bf149 file://hello.sh
-```
+    sonic execute --tags Name=demo-web uptime
+    sonic execute --tags Name=demo-web,demo-worker uptime # multiple tag values
+    sonic execute --instance-ids i-030033c20c54bf149,i-030033c20c54bf150 uname -a
+    sonic execute --instance-ids i-030033c20c54bf149 file://hello.sh
 
 ## 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.
-$
-```
+    $ sonic execute --instance-ids i-0bf51a000ab4e73a8 uptime
+    Sending command to SSM with options:
+    ---
+    instance_ids:
+    - i-0bf51a000ab4e73a8
+    document_name: AWS-RunShellScript
+    comment: sonic execute --instance-ids 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:
 
@@ -69,28 +63,30 @@ The AWS SSM console looks like this:
 
 <img src="/img/tutorials/ec2-console-run-command.png" class="doc-photo" />
 
-### Polymorphic Filter
+### Filter Options
 
-The `sonic execute` command can understand a variety of different filters.  The filters can be a list of instances ids or one EC2 tag value.  Note, ECS service names are *not* supported for the filter.
+The `sonic execute` command can understand a variety of different filters: `--tags` and `--instance-ids`.  Note, ECS service names are *not* supported for the filter.
 
 Here is an example, where the uptime command will run on both `i-030033c20c54bf149` and `i-030033c20c54bf150` instances.
 
-```sh
-sonic execute i-066b140d9479e9681,i-09482b1a6e330fbf7 uptime
-```
+    sonic execute --instance-ids i-066b140d9479e9681,i-09482b1a6e330fbf7 uptime
+
+Here is an example, where the uptime command will run on instances tagged with `Name=demo-web`
+
+    sonic execute --tags Name=demo-web uptime
 
 ## Windows Support
 
 Windows is also supported. When running a command sonic will first attempt to use the `AWS-RunShellScript` run command, and if it detects that the instance's platform does not support `AWS-RunShellScript`, it will run the command with the `AWS-RunPowerShellScript` run command.  Here's an example:
 
 ```
-$ sonic execute i-0917ad61b10fa1059 pwd
+$ sonic execute --instance-ids i-0917ad61b10fa1059 pwd
 Sending command to SSM with options:
 ---
 instance_ids:
 - i-0917ad61b10fa1059
 document_name: AWS-RunShellScript
-comment: sonic execute i-0917ad61b10fa1059 pwd
+comment: sonic execute --instance-ids i-0917ad61b10fa1059 pwd
 parameters:
   commands:
   - pwd
@@ -129,16 +125,12 @@ $
 
 Sometimes you might want to run more than just a one-liner command. If you need to run a full script, you can provide the file path to the script by designating it with `file://`.  For example, here's a file called `hi.sh`:
 
-```bash
-#!/bin/bash
-echo "hello world"
-```
+    #!/bin/bash
+    echo "hello world"
 
 Here's how you run that file:
 
-```sh
-sonic execute hi-web file://hi.sh
-```
+    sonic execute demo-web file://hi.sh
 
 The file gets read by `sonic execute` and sent to EC2 Run Command to be executed.
 

data/docs/_docs/tutorial-ssh.md

@@ -39,7 +39,8 @@ sonic ssh ubuntu@i-0f7f833131a51ce35
 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
+ssh:
+  user: ec2-user
 ```
 
 More information about sonic settings in available in the docs: [Settings]({% link _docs/settings.md %}).

data/docs/_includes/footer.html

@@ -6,10 +6,12 @@
                     <div class="footer-col col-md-4">
                         <h3>More Tools</h3>
                         <ul class="list-unstyled tools">
-                            <li><a href="http://jack-eb.com">Jack</a></li>
-                            <li><a href="http://lono.cloud">Lono</a></li>
-                            <li><a href="http://ufoships.com">Ufo</a></li>
-                            <li><a href="https://boltops.com/toolbelt">Toolbelt</a></li>
+                            <li><a href="https://terraspace.cloud">Terraspace</a></li>
+                            <li><a href="https://kubes.guru">Kubes</a></li>
+                            <li><a href="https://rubyonjets.com">Jets</a></li>
+                            <li><a href="https://ufoships.com">Ufo</a></li>
+                            <li><a href="https://lono.cloud">Lono</a></li>
+                            <li><a href="https://jack-eb.com">Jack</a></li>
                         </ul>
                     </div>
                     <div class="footer-col col-md-4">

data/docs/_reference/sonic-execute.md

@@ -11,14 +11,15 @@ reference: true
 
 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.
+* A filter must be provided.  The filter can be a mix of instance ids and ec2 tags.
+* The command can be provided inline or as a file. 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
+    sonic execute --tags Name=demo-web uptime
+    sonic execute --tags Name=demo-web,demo-worker uptime # multiple values
+    sonic execute --instance-ids i-030033c20c54bf149,i-030033c20c54bf150 uname -a
+    sonic execute --instance-ids i-030033c20c54bf149 file://hello.sh # script from file
 
 You cannot mix instance ids and tag names in the filter.
 
@@ -26,39 +27,37 @@ You cannot mix instance ids and tag names in the filter.
 
 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.
-$
-```
+    $ sonic execute --instance-ids i-0bf51a000ab4e73a8 uptime
+    Sending command to SSM with options:
+    ---
+    instance_ids:
+    - i-0bf51a000ab4e73a8
+    document_name: AWS-RunShellScript
+    comment: sonic execute --instance-ids 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:
 
@@ -78,6 +77,8 @@ The AWS SSM console looks like this:
 ```
 [--zero-warn], [--no-zero-warn]  # Warns user when no instances found
                                  # Default: true
+[--instance-ids=INSTANCE_IDS]    # Instance ids to execute command on. Format: --instance-ids "i-111,i-222"
+[--tags=TAGS]                    # Tags used to determine what instances to execute command on. Format: --tags "Key1=v1,v2;Key2=v3"
 [--verbose], [--no-verbose]      
 [--noop], [--no-noop]            
 ```