knuckle_cluster 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1f4c2401bd2ba5e45bde345234fea0af87f75d2
-  data.tar.gz: 23cb6fb4cddbfd168e5940463387104445720bf2
+  metadata.gz: d4179fb4fe181bb800defdb0634691c7c85f9c63
+  data.tar.gz: e3c7e7786cba37a32531d4425dbed70e7713936c
 SHA512:
-  metadata.gz: d8c7e0fc10f7d44b0269ac8c9317a25ba08c6f2f2e96b084ee58d89713791ca9960ca40cc6f834ad423d9b09fce130af7f344d08376a2971a4a2e01a53312f99
-  data.tar.gz: 4ef267008c44f2550a64d41bd40d6b9bb37bb6290770dc69704fd6024c3a6f43d4ff9de135a00d48908eeb6332ebcd112d0ee8d2d73b2fa091a6f4c58404697e
+  metadata.gz: e09f159cae31ec646190f7c31457956c2b797e15e4e7f79096b03f0892171382d62b5eb5e58e62de3ccb62383bb629a07f8c06282ce708cf51c3be6336f54e1e
+  data.tar.gz: 2c9fd926e86258191a459ae27df48c360ccd7b11bbeb3371ec0907b7eaabe2de9cc2c57fc2c2395be130e6ec9f1afec46070b0d0a35bec984aea05c3f0a77284

data/README.md

@@ -2,6 +2,7 @@
 
 Have you ever wanted to shuck away the hard, rough exterior of an ECS cluster and get to the soft, chewy innards? Sounds like you need KnuckleCluster!
 This tool provides scripts, invoked via cli or rakefile, to list, connect to and/or run commands on ecs agents and containers via ssh.  This makes it very easy to interrogate ECS agents and containers without having to go digging for IP addresses and things.
+Primarily created as a tool to connect to instances in an ECS cluster and see what is running on them, it has evolved slightly to include the ability to list instances in spot requests and auto-scaling groups.
 
 ## Features
 * See what agents in your ECS cluster are doing
@@ -11,7 +12,7 @@ This tool provides scripts, invoked via cli or rakefile, to list, connect to and
 * Optionally integrates with [aws-vault](https://github.com/99designs/aws-vault) for AWS authentication
 
 ## Development Status
-Is being used in production for various projects and is considered stable. Any new features/bug fixes etc are most welcome!  Test coverage is minimal...
+Is being used in production for various projects and is considered stable. Any new features/bug fixes etc are most welcome!
 
 ## Installation
 
@@ -185,8 +186,9 @@ Possible options are below. If left blank, they will be ignored and defaults use
 
 Argument | Description
 -------- | -----------
-cluster_name | The name of the cluster (not the ARN). eg 'my-super-cluster'. Required (unless using spot_request_id)
-spot_request_id | The spot request ID you are connecting to. eg 'sfr-abcdef'. Required (unless using cluster_name)
+cluster_name | The name of the cluster (not the ARN). eg 'my-super-cluster'. One of `cluster_name`,`spot_request_id` or `asg_name` is required.
+spot_request_id | The spot request ID you are connecting to. eg 'sfr-abcdef'. One of `cluster_name`,`spot_request_id` or `asg_name` is required.
+asg_name | The spot request ID you are connecting to. eg 'sfr-abcdef'. One of `cluster_name`,`spot_request_id` or `asg_name` is required.
 region | The AWS region you would like to use. Defaults to `us-east-1`
 bastion | if you have a bastion to proxy to your ecs cluster via ssh, put the name of it here as defined in your `~/.ssh/config` file.
 rsa_key_location | The RSA key needed to connect to an ecs agent eg `~/.ssh/id_rsa`.
@@ -196,7 +198,10 @@ aws_vault_profile | If you use the `aws-vault` tool to manage your AWS credentia
 profile | Another profile to inherit settings from. Settings from lower profiles can be overridden in higher ones.
 
 ## Spot Fleets
-If you wish to see what instances are running within a spot fleet, KnuckleCluster can do that too!.  In your config, use `spot_request_id` instead of `cluster_name`.  Note that the `containers` command will not work when invoking.
+If you wish to see what instances are running within a spot fleet, KnuckleCluster can do that too!.  In your config, use `spot_request_id` instead of `cluster_name`.  Note that the `containers` command will not work when invoking (use `agents` instead).
+
+## AutoScaling Groups
+If you wish to see what instances are running within an ASG, KnuckleCluster can do that too!.  In your config, use `asg_name` instead of `cluster_name`.  Note that the `containers` command will not work when invoking (use `agents` instead).
 
 ## Maintainer
 [Envato](https://github.com/envato)

data/lib/knuckle_cluster.rb

@@ -1,3 +1,4 @@
+require 'knuckle_cluster/asg_instance_registry'
 require 'knuckle_cluster/ecs_agent_registry'
 require 'knuckle_cluster/spot_request_instance_registry'
 require "knuckle_cluster/version"
@@ -14,6 +15,7 @@ module KnuckleCluster
     def new(
         cluster_name: nil,
         spot_request_id: nil,
+        asg_name: nil,
         region: 'us-east-1',
         bastion: nil,
         rsa_key_location: nil,
@@ -24,6 +26,7 @@ module KnuckleCluster
         tunnels: {})
       @cluster_name      = cluster_name
       @spot_request_id   = spot_request_id
+      @asg_name          = asg_name
       @region            = region
       @bastion           = bastion
       @rsa_key_location  = rsa_key_location
@@ -33,8 +36,8 @@ module KnuckleCluster
       @shortcuts         = shortcuts
       @tunnels           = tunnels
 
-      if @cluster_name.nil? && @spot_request_id.nil?
-        raise "Must specify either cluster_name or spot_request_id"
+      if @cluster_name.nil? && @spot_request_id.nil? && @asg_name.nil?
+        raise "Must specify either cluster_name, spot_request_id or asg name"
       end
       self
     end
@@ -78,7 +81,8 @@ module KnuckleCluster
 
     private
 
-    attr_reader :cluster_name, :spot_request_id, :region, :bastion, :rsa_key_location, :ssh_username,
+    attr_reader :cluster_name, :spot_request_id, :asg_name,
+                :region, :bastion, :rsa_key_location, :ssh_username,
                 :sudo, :aws_vault_profile, :shortcuts, :tunnels
 
     def select_agent(auto:)
@@ -196,6 +200,11 @@ module KnuckleCluster
             aws_client_config: aws_client_config,
             spot_request_id:   spot_request_id,
           )
+        elsif @asg_name
+          AsgInstanceRegistry.new(
+            aws_client_config: aws_client_config,
+            asg_name:          asg_name,
+          )
         end
       )
     end

data/lib/knuckle_cluster/asg_instance_registry.rb

@@ -0,0 +1,58 @@
+require 'knuckle_cluster/agent'
+
+require 'forwardable'
+
+module KnuckleCluster
+  class AsgInstanceRegistry
+    extend Forwardable
+
+    def initialize(aws_client_config:, asg_name:)
+      @aws_client_config = aws_client_config
+      @asg_name   = asg_name
+    end
+
+    def agents
+      @agents ||= load_agents
+    end
+
+    def output_agents
+      tp agents,
+        :index,
+        :instance_id,
+        # :public_ip,
+        :private_ip,
+        :availability_zone
+    end
+
+    private
+
+    attr_reader :aws_client_config, :asg_name
+
+    def load_agents
+      auto_scaling_instances = autoscaling_client.describe_auto_scaling_groups(auto_scaling_group_names: [@asg_name]).to_h
+
+      instance_ids = auto_scaling_instances[:auto_scaling_groups][0][:instances].map{|instance| instance[:instance_id]}
+
+      instance_reservations = ec2_client.describe_instances(instance_ids: instance_ids).reservations
+
+      instance_reservations.map(&:instances).flatten.map.with_index do |instance, index|
+        Agent.new(
+          index:                  index + 1,
+          instance_id:            instance[:instance_id],
+          public_ip:              instance[:public_ip_address],
+          private_ip:             instance[:private_ip_address],
+          availability_zone:      instance.dig(:placement, :availability_zone),
+        )
+      end
+    end
+
+    def ec2_client
+      @ec2_client ||= Aws::EC2::Client.new(aws_client_config)
+    end
+
+    def autoscaling_client
+      @autoscaling_client ||= Aws::AutoScaling::Client.new(aws_client_config)
+    end
+
+  end
+end

data/lib/knuckle_cluster/version.rb

@@ -1,3 +1,3 @@
 module KnuckleCluster
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knuckle_cluster
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Envato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-24 00:00:00.000000000 Z
+date: 2017-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,6 +103,7 @@ files:
 - knuckle_cluster.gemspec
 - lib/knuckle_cluster.rb
 - lib/knuckle_cluster/agent.rb
+- lib/knuckle_cluster/asg_instance_registry.rb
 - lib/knuckle_cluster/configuration.rb
 - lib/knuckle_cluster/container.rb
 - lib/knuckle_cluster/ecs_agent_registry.rb