ecs_cmd 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 364c2ce1e5efde7c1b03633a2a49538bb3e67a8b7a144ae7f64fe0cd6bf01237
-  data.tar.gz: acb50a84aa34496a6cead40dac6e6eac938685b59ce6d0fdf1dee7a48de065e2
+  metadata.gz: d71f58e4a9633203372ae063a6092f3e240706512e78194d3c826ee917061067
+  data.tar.gz: 596040a7991d22b567f6949628bd8e6ff8196f6c43c6b3b12961a7c16e40f11d
 SHA512:
-  metadata.gz: 499703cbf2f95e27647ed1f735523aade77009bf078161151dc4609d53ebd3551cddf87ae0d4cb530f63d5397276405caef17c6ed14060e1500bfb74bf460604
-  data.tar.gz: 84b96c418ac4fe57931185e3f032b5612fddb95b13b11e4c8b25fdb1672babc81f2af94837733f2b42651755ac9f5f89644cc431f027e5739f417e67a7f6f321
+  metadata.gz: c15acb739bb663c7a6f42627dd6d8e47b440b7de2964d48ee6d919cfcc2f8517ba2e06647e195058992ce5b1092bc3b9dbcf11c57af1a87892fee683998580b5
+  data.tar.gz: 3fd61f53280919e2c9cefc57a02167e7c3fd2c423b427f8be7d8bef0755bbd80f0fe111fe86653d113fcde5d9acc15c156724d881c1e0f63ae873708b85c86bb

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# 0.1.4
+
+- Added user flag to shell command. `ecs-cmd shell -c production -s foo -u nobody`
+- Added user flag to exec command. `ecs-cmd exec -c production -s foo -u nobody whoami`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ecs_cmd (0.1.3)
+    ecs_cmd (0.1.4)
       aws-sdk-ec2
       aws-sdk-ecs
       gli (= 2.17.1)
@@ -52,6 +52,7 @@ GEM
 
 PLATFORMS
   ruby
+  x86_64-darwin-17
 
 DEPENDENCIES
   bundler (~> 1.16)

data/README.md

@@ -2,29 +2,220 @@
 
 [![Build Status](https://travis-ci.org/dschaaff/ecs-cmd.svg?branch=master)](https://travis-ci.org/dschaaff/ecs-cmd) [![Gem Version](https://badge.fury.io/rb/ecs_cmd.svg)](https://badge.fury.io/rb/ecs_cmd)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ecs_cmd`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This is a command line application for interacting with AWS ECS. The standard AWS cli can be a bit
+cumbersome for some tasks. Ecs-cmd aims to simplify those tasks.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+```bash
+gem install ecs_cmd
+```
+
+The gem uses the standard aws crendential chain for authentication actions. See https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html for reference.
 
-```ruby
-gem 'ecs_cmd'
+## Usage
+
+```
+ecs-cmd
+NAME
+    ecs-cmd - Command utility for interacting with AWS ECS
+
+SYNOPSIS
+    ecs-cmd [global options] command [command options] [arguments...]
+
+VERSION
+    0.1.3
+
+GLOBAL OPTIONS
+    --help              - Show this message
+    -r, --region=region - Set the aws region (default: us-east-1)
+    --version           - Display the program version
+
+COMMANDS
+    exec     - Execute a Command Within a Service's Container
+    get      - Get Info on Clusters and Services
+    help     - Shows a list of commands or help for one command
+    logs     - Tail Logs From a Service's Container
+    run-task - Run a One Off Task On an ECS Cluster
+    shell    - Open a Shell Inside a Service's Container
+    ssh      - SSH into Host Task is Running On
 ```
 
-And then execute:
+### Get Commands
 
-    $ bundle
+These allow you to query information from ECS.
 
-Or install it yourself as:
+#### Get Clusters
 
-    $ gem install ecs_cmd
+```
+ ecs-cmd get clusters
++--------------------+--------------------------+----------+---------------+---------------+
+| CLUSTER NAME       | CONTAINER_INSTANCE_COUNT | SERVICES | RUNNING_TASKS | PENDING_TASKS |
++--------------------+--------------------------+----------+---------------+---------------+
+| production         | 20                       | 39       | 82            | 0             |
+| development        | 1                        | 2        | 1             | 0             |
++--------------------+--------------------------+----------+---------------+---------------+
+```
 
-## Usage
+#### Get Services
+
+Prints an overview of the services in a given cluster.
+
+```shella
+ecs-cmd get services --help
+NAME
+    services -
+
+SYNOPSIS
+    ecs-cmd [global options] get services [command options]
+
+COMMAND OPTIONS
+    -c, --cluster=cluster - cluster name (required, default: none)
+```
+
+```shell
+ecs-cmd get services -c testing
++--------------------+---------------+---------------+---------------+
+| SERVICE NAME       | DESIRED_COUNT | RUNNING_COUNT | PENDING_COUNT |
++--------------------+---------------+---------------+---------------+
+| datadog-agent      | 1             | 0             | 0             |
+| foo-bar            | 1             | 1             | 0             |
++--------------------+---------------+---------------+---------------+
+```
+
+#### Get Service
+
+Get information on a specific service in a cluster.
+
+```shell
+cs-cmd get service --help
+NAME
+    service -
+
+SYNOPSIS
+    ecs-cmd [global options] get service [command options]
+
+COMMAND OPTIONS
+    -c, --cluster=cluster      - cluster name (required, default: none)
+    -e, --[no-]events          - get ecs events
+    -s, --service=service      - service name (required, default: none)
+    -t, --[no-]task_definition - get current task definition for service
+```
+
+```shell
+ecs-cmd get service -c production -s foo
++------+--------+---------------+---------------+---------------+-------------+-------------+
+| NAME | STATUS | RUNNING COUNT | DESIRED COUNT | PENDING COUNT | MAX HEALTHY | MIN HEALTHY |
++------+--------+---------------+---------------+---------------+-------------+-------------+
+| foo  | ACTIVE | 2             | 2             | 0             | 200         | 50          |
++------+--------+---------------+---------------+---------------+-------------+-------------+
++----------------------------------------------------------------------+
+| TASK DEFINITION                                                      |
++----------------------------------------------------------------------+
+| arn:aws:ecs:us-east-1:xxxxxxxxxxxx:task-definition/foo-production:25 |
++----------------------------------------------------------------------+
++---------------------+--------------+
+| INSTANCE ID         | IP           |
++---------------------+--------------+
+| i-xxxxxxxxxxxxxxxxx | 10.0.230.1   |
+| i-xxxxxxxxxxxxxxxxx | 10.0.220.3   |
++---------------------+--------------+
++-----------------+----------------------------------------------------------------------+
+| DEPLOYMENTS     |                                                                      |
++-----------------+----------------------------------------------------------------------+
+| id              | ecs-svc/xxxxxxxxxxxxxxxxxxx                                          |
+| status          | PRIMARY                                                              |
+| task definition | arn:aws:ecs:us-east-1:xxxxxxxxxxxx:task-definition/foo-production:25 |
+| desired count   | 2                                                                    |
+| pending count   | 0                                                                    |
+| running count   | 2                                                                    |
+| created at      | 2018-12-07 09:44:59 -0800                                            |
+| updated at      | 2018-12-07 09:45:58 -0800                                            |
+
++-----------------+----------------------------------------------------------------------+
+```
+
+### Logs
 
-TODO: Write usage instructions here
+*requires ssh access to instance*
+
+Streams logs from 1 of a services running tasks using the docker logs command
+
+```shell
+ecs-cmd logs --help
+NAME
+    logs - Tail Logs From a Service's Container
+
+SYNOPSIS
+    ecs-cmd [global options] logs [command options]
+
+COMMAND OPTIONS
+    -c, --cluster=cluster - cluster name (required, default: none)
+    -l, --lines=lines     - number of historical lines to tail (default: 30)
+    -s, --service=service - service name (required, default: none)
+```
+
+### Run Task
+
+Run a one off task in ECS. This will poll for the task to exit and report its exit code. This is
+handy for tasks like rails migrations. If a docker image is passed it will create a new revision of 
+the task definition prior to running the task.
+
+```shell
+ecs-cmd run-task --help
+NAME
+    run-task - Run a One Off Task On an ECS Cluster
+
+SYNOPSIS
+    ecs-cmd [global options] run-task [command options]
+
+COMMAND OPTIONS
+    -c, --cluster=cluster               - cluster name (required, default: none)
+    -d, --command=command               - override task definition command (default: none)
+    -i, --image=image                   - docker image to use for task (default: none)
+    -n, --container-name=container name - container name (default: none)
+    -t, --task-definition=arg           - the task definition to use for task (required, default: none)
+```
+
+### Shell
+
+*requires ssh access to instance*
+
+Open a shell inside of a container for a given service.
+
+```shell
+ecs-cmd shell --help
+NAME
+    shell - Open a Shell Inside a Service's Container
+
+SYNOPSIS
+    ecs-cmd [global options] shell [command options]
+
+COMMAND OPTIONS
+    -c, --cluster=cluster - cluster name (required, default: none)
+    -s, --service=service - service name (required, default: none)
+    --[no-]sh             - use sh instead of bash
+    -u, --user=user       - user name or uid (default: root)
+```
+
+### SSH
+
+*requires ssh access to instance*
+
+SSH onto a host where a container for a given service is running.
+
+```shell
+ecs-cmd ssh --help
+NAME
+    ssh - SSH into Host Task is Running On
+
+SYNOPSIS
+    ecs-cmd [global options] ssh [command options]
+
+COMMAND OPTIONS
+    -c, --cluster=cluster - cluster name (required, default: none)
+    -s, --service=service - service name (required, default: none)
+```
 
 ## Development
 

data/bin/ecs-cmd

@@ -89,12 +89,13 @@ arg_name 'command', :required
 command :exec do |c|
   c.flag %i[c cluster], desc: 'cluster name', arg_name: 'cluster', required: true
   c.flag %i[s service], desc: 'service name', arg_name: 'service', required: true
+  c.flag %i[u user], desc: 'user name or uid', arg_name: 'user', default_value: 'root', required: false
   c.action do |global_options, options, args|
     service = EcsCmd::Service.new(options[:c], options[:s], global_options[:region])
     ip = service.container_instance_ips[0]
     task_family = service.task_family
     command = args.join(' ')
-    EcsCmd::Exec.execute(task_family, ip, command)
+    EcsCmd::Exec.execute(task_family, ip, command, options[:u])
   end
 end
 
@@ -102,13 +103,14 @@ desc "Open a Shell Inside a Service's Container"
 command 'shell' do |c|
   c.flag %i[c cluster], desc: 'cluster name', arg_name: 'cluster', required: true
   c.flag %i[s service], desc: 'service name', arg_name: 'service', required: true
+  c.flag %i[u user], desc: 'user name or uid', arg_name: 'user', default_value: 'root', required: false
   c.switch %i[sh], desc: 'use sh instead of bash', default_value: false
   c.action do |global_options, options, args|
     service = EcsCmd::Service.new(options[:c], options[:s], global_options[:region])
     ip = service.container_instance_ips[0]
     task_family = service.task_family
     shell = options[:sh] ? 'sh' : 'bash'
-    EcsCmd::Exec.shell(task_family, ip, shell)
+    EcsCmd::Exec.shell(task_family, ip, shell, options[:u])
   end
 end
 

data/lib/ecs_cmd/exec.rb

@@ -17,8 +17,8 @@ module EcsCmd
       end
 
       # used to run arbitrary command inside a container
-      def execute(task_family, ip, command)
-        cmd = "docker exec -i -t `#{docker_ps_task(task_family)}` #{command}"
+      def execute(task_family, ip, command, user = 'root')
+        cmd = "docker exec -i -t -u #{user} `#{docker_ps_task(task_family)}` #{command}"
         Open3.popen2e(ssh_cmd(ip) + " '#{cmd}' ") do |stdin, stdout, stderr, status_thread|
           stdout.each_line do |line|
             puts line
@@ -27,8 +27,8 @@ module EcsCmd
       end
 
       # used to open a shell within a container?
-      def shell(task_family, ip, shell='bash')
-        cmd = "docker exec -i -t `#{docker_ps_task(task_family)}` #{shell}"
+      def shell(task_family, ip, shell = 'bash', user = 'root')
+        cmd = "docker exec -i -t -u #{user} `#{docker_ps_task(task_family)}` #{shell}"
         exec(ssh_cmd(ip) + " '#{cmd}' ")
       end
 

data/lib/ecs_cmd/version.rb

@@ -1,3 +1,3 @@
 module EcsCmd
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecs_cmd
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Daniel Schaaff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-10 00:00:00.000000000 Z
+date: 2018-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-ec2
@@ -134,6 +134,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock