sonic-screwdriver 1.4.0 → 2.2.1

data/docs/_includes/commands.html

@@ -11,15 +11,15 @@
                 <div class="col-lg-8 col-lg-offset-2">
                     <div class="commands">
 {% highlight sh %}
-sonic ssh
+sonic ssh # ssh onto instance
 
-sonic ecs-run
+sonic ecs sh # docker run on ECS
 
-sonic ecs-exec
+sonic ecs exec # docker exec on ECS
 
-sonic list
+sonic list # list servers
 
-sonic execute
+sonic execute # run command with SSM
 {% endhighlight %}
                     </div>
                 </div>

data/docs/_includes/content.html

@@ -8,6 +8,11 @@
     <section id="main">
         <div class="container">
             <div class="row">
+                {% if page.reference %}
+                <div class="col-md-9 reference-nav">
+                    <a href="/reference">Back to Reference Index</a>
+                </div>
+                {% endif %}
                 <div class="col-md-9 content-body">
                     <h2>{{ page.title }}</h2>
                     {{ content }}

data/docs/_includes/css/main.css

@@ -9,11 +9,13 @@ body {
 }
 
 p {
-    font-size: 20px;
+    /*font-size: 20px;*/
+    font-size: 1.2em;
 }
 
 p.small {
-    font-size: 16px;
+    font-size: 1em;
+    /*font-size: 16px;*/
 }
 
 a,
@@ -31,16 +33,21 @@ h3,
 h4,
 h5,
 h6 {
-    text-transform: uppercase;
     font-family: Montserrat,"Helvetica Neue",Helvetica,Arial,sans-serif;
     font-weight: 700;
 }
 
-h3,
-h4,
-h5,
-h6 {
-    text-transform: none;
+h1 {
+    font-size: 1.6em;
+}
+h2 {
+    font-size: 1.5em;
+}
+h3 {
+    font-size: 1.4em;
+}
+h4 {
+    font-size: 1.3em;
 }
 
 hr.star-light,
@@ -201,7 +208,6 @@ section {
 section h2 {
     margin: 0;
     margin-bottom: 15px;
-    font-size: 2em;
 }
 
 section.success {

data/docs/_includes/css/sonic.css

@@ -28,7 +28,7 @@ section#main .intro-text .name {
     display: block;
     text-transform: uppercase;
     font-family: Montserrat,"Helvetica Neue",Helvetica,Arial,sans-serif;
-    font-size: 2em;
+    font-size: 1.5em;
     font-weight: 700;
 }
 
@@ -58,22 +58,23 @@ section#main .intro-text .skills {
 
 .content-body {
     text-align: left;
-    font-size: 1.2em;
+    font-size: 1em;
 }
 
 .content-body h2 {
-    text-align: center;
+    text-align: left;
 }
 
 .content-body ul,
 .content-body ol {
     margin-top: 0;
+    font-size: 17px;
 }
 
 .content-nav {
     /*background-color: green;*/
     margin-top: 40px;
-    font-size: 1.25em;
+    font-size: 1.15em;
 }
 
 .content-nav ul, .content-nav ol {
@@ -95,6 +96,7 @@ section#main .intro-text .skills {
 code {
     color: #443e40;
     background-color: #cdcbd4;
+    font-size: 0.72em;
 }
 
 footer h3 {
@@ -140,7 +142,7 @@ ul.tools li {
 .edit-on-github h2,
 .edit-on-github p,
 .edit-on-github li {
-    font-size: 1.5em;
+    /*font-size: 1.5em;*/
 }
 
 .use-cases {

data/docs/_includes/example.html

@@ -10,10 +10,10 @@
       <div class='col-md-offset-1 col-md-10'>
         <p>With one command you can go from your local machine into a live ECS running docker container. Boom!</p>
 {% highlight sh %}
-$ sonic ecs-exec hi-web-prod --cluster stag
-Running: scp -r /tmp/sonic ec2-user@ec2-52-24-216-170.us-west-2.compute.amazonaws.com:/tmp/sonic  > /dev/null
-=> ssh -t ec2-user@ec2-52-24-216-170.us-west-2.compute.amazonaws.com bash /tmp/sonic/bash_scripts/docker-exec.sh
-root@b371924fce50:/app#
+$ sonic ecs exec boltops-web
+...
++ exec docker exec -ti 385b643c7a895231d2b193574368b0c6c6bebce487267c3c175d0acea3082d4c bash
+root@385b643c7a89:/app#
 {% endhighlight %}
       </div>
     </div>

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/_includes/reference.md

@@ -0,0 +1 @@
+Multi-functional tool to manage AWS infrastructure. A swiss army knife with a variety of uses.

data/docs/_includes/subnav.html

@@ -11,7 +11,7 @@
             <ul class="tutorial">
                 <li><a href="{% link _docs/tutorial-ssh.md %}">SSH</a></li>
                 <li><a href="{% link _docs/tutorial-ecs-exec.md %}">ECS Exec</a></li>
-                <li><a href="{% link _docs/tutorial-ecs-run.md %}">ECS Run</a></li>
+                <li><a href="{% link _docs/tutorial-ecs-sh.md %}">ECS Run</a></li>
                 <li><a href="{% link _docs/tutorial-execute.md %}">Execute</a></li>
                 <li><a href="{% link _docs/tutorial-list.md %}">List</a></li>
             </ul>
@@ -25,5 +25,6 @@
         </li>
         <li><a href="{% link _docs/how-it-works.md %}">How It Works</a></li>
         <li><a href="{% link _docs/next-steps.md %}">Next Steps</a></li>
+        <li><a href="{% link reference.md %}">CLI Reference</a></li>
     </ul>
 </div>

data/docs/_reference/sonic-completion.md

@@ -0,0 +1,44 @@
+---
+title: sonic completion
+reference: true
+---
+
+## Usage
+
+    sonic completion *PARAMS
+
+## Description
+
+Prints words for auto-completion.
+
+Example:
+
+    sonic completion
+
+Prints words for TAB auto-completion.
+
+Examples:
+
+    sonic completion
+    sonic completion execute
+    sonic completion list
+
+To enable, TAB auto-completion add the following to your profile:
+
+    eval $(sonic completion_script)
+
+Auto-completion example usage:
+
+    sonic [TAB]
+    sonic exe[TAB]
+    sonic execute [TAB]
+    sonic list [TAB]
+
+
+## Options
+
+```
+[--verbose], [--no-verbose]  
+[--noop], [--no-noop]        
+```
+

data/docs/_reference/sonic-completion_script.md

@@ -0,0 +1,25 @@
+---
+title: sonic completion_script
+reference: true
+---
+
+## Usage
+
+    sonic completion_script
+
+## Description
+
+Generates a script that can be eval to setup auto-completion.
+
+To use, add the following to your `~/.bashrc` or `~/.profile`
+
+    eval $(sonic completion_script)
+
+
+## Options
+
+```
+[--verbose], [--no-verbose]  
+[--noop], [--no-noop]        
+```
+

data/docs/_reference/sonic-ecs-exec.md

@@ -0,0 +1,30 @@
+---
+title: sonic ecs exec
+reference: true
+---
+
+## Usage
+
+    sonic ecs exec [ECS_SERVICE]
+
+## Description
+
+docker exec into running docker container associated with the service on a container instance
+
+Ssh into an ECS container instance, finds a running docker container associated
+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.
+
+
+## Options
+
+```
+[--bastion=BASTION]  # Bastion jump host to use.  Defaults to no bastion server.
+[--cluster=CLUSTER]  # ECS Cluster to use.  Default cluster is default
+```
+

data/docs/_reference/sonic-ecs-help.md

@@ -0,0 +1,21 @@
+---
+title: sonic ecs help
+reference: true
+---
+
+## Usage
+
+    sonic ecs help [COMMAND]
+
+## Description
+
+Describe subcommands or one specific subcommand
+
+
+## Options
+
+```
+[--bastion=BASTION]  # Bastion jump host to use.  Defaults to no bastion server.
+[--cluster=CLUSTER]  # ECS Cluster to use.  Default cluster is default
+```
+

data/docs/_reference/sonic-ecs-sh.md

@@ -0,0 +1,35 @@
+---
+title: sonic ecs sh
+reference: true
+---
+
+## Usage
+
+    sonic ecs sh [ECS_SERVICE]
+
+## Description
+
+docker run with the service on a container instance
+
+Ssh into an ECS container instance and runs a docker container using the same
+environment and image as the specified running service.
+
+Examples:
+
+    $ sonic ecs sh --cluster my-cluster my-service
+    $ sonic ecs sh --cluster my-cluster my-service
+
+# If there are flags in the command that you want to pass down to the docker
+run command you will need to put the command in single quotes.  This is due to
+the way Thor (what this tool uses) parses options.
+
+    $ sonic ecs sh --cluster production-hi hi-web 'rake -T'
+
+
+## Options
+
+```
+[--bastion=BASTION]  # Bastion jump host to use.  Defaults to no bastion server.
+[--cluster=CLUSTER]  # ECS Cluster to use.  Default cluster is default
+```
+

data/docs/_reference/sonic-ecs.md

@@ -0,0 +1,25 @@
+---
+title: sonic ecs
+reference: true
+---
+
+## Usage
+
+    sonic ecs SUBCOMMAND
+
+## Description
+
+ecs subcommands
+
+## Subcommands
+
+* [sonic ecs exec]({% link _reference/sonic-ecs-exec.md %}) - docker exec into running docker container associated with the service on a container instance
+* [sonic ecs sh]({% link _reference/sonic-ecs-sh.md %}) - docker run with the service on a container instance
+
+## Options
+
+```
+[--verbose], [--no-verbose]  
+[--noop], [--no-noop]        
+```
+

data/docs/_reference/sonic-execute.md

@@ -0,0 +1,85 @@
+---
+title: sonic execute
+reference: true
+---
+
+## Usage
+
+    sonic execute [FILTER] [COMMAND]
+
+## Description
+
+Runs command across fleet of servers via AWS Run Command.
+
+* 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 --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.
+
+## Example Detailed
+
+Here's a command example output in detailed:
+
+    $ 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:
+
+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
+[--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]            
+```
+