knuckle_cluster 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1938a27084e6da4bd72ce501a8e373a5a919b18
-  data.tar.gz: e27ce437a1519ce998b79429d00ca18c793a9fae
+  metadata.gz: a1f4c2401bd2ba5e45bde345234fea0af87f75d2
+  data.tar.gz: 23cb6fb4cddbfd168e5940463387104445720bf2
 SHA512:
-  metadata.gz: 3b470a48b031d80f4761aa538243862beb946e46825b37fbdd361db52216452d21bca92ae02641e62804303b50823590edf2a5eea91ff081d6f26c94a685872c
-  data.tar.gz: 56ef57f3f84bc4cc707296d67592b5ac8e5867a94663b0f2fe21eda609c154fbc70c9f94feb6f9e231a05e09c6dd9f247a789bebe40151d528ef1f10cbd46ad7
+  metadata.gz: d8c7e0fc10f7d44b0269ac8c9317a25ba08c6f2f2e96b084ee58d89713791ca9960ca40cc6f834ad423d9b09fce130af7f344d08376a2971a4a2e01a53312f99
+  data.tar.gz: 4ef267008c44f2550a64d41bd40d6b9bb37bb6290770dc69704fd6024c3a6f43d4ff9de135a00d48908eeb6332ebcd112d0ee8d2d73b2fa091a6f4c58404697e

data/README.md

@@ -185,7 +185,8 @@ 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
+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)
 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`.
@@ -194,6 +195,8 @@ sudo | true or false - will sudo the `docker` command on the target machine. Usu
 aws_vault_profile | If you use the `aws-vault` tool to manage your AWS credentials, you can specify a profile here that will be automatically used to connect to this cluster.
 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.
 
 ## Maintainer
 [Envato](https://github.com/envato)

data/lib/knuckle_cluster.rb

@@ -1,4 +1,5 @@
-require 'knuckle_cluster/agent_registry'
+require 'knuckle_cluster/ecs_agent_registry'
+require 'knuckle_cluster/spot_request_instance_registry'
 require "knuckle_cluster/version"
 require "knuckle_cluster/configuration"
 
@@ -11,7 +12,8 @@ module KnuckleCluster
     extend Forwardable
 
     def new(
-        cluster_name:,
+        cluster_name: nil,
+        spot_request_id: nil,
         region: 'us-east-1',
         bastion: nil,
         rsa_key_location: nil,
@@ -21,6 +23,7 @@ module KnuckleCluster
         shortcuts: {},
         tunnels: {})
       @cluster_name      = cluster_name
+      @spot_request_id   = spot_request_id
       @region            = region
       @bastion           = bastion
       @rsa_key_location  = rsa_key_location
@@ -29,6 +32,10 @@ module KnuckleCluster
       @aws_vault_profile = aws_vault_profile
       @shortcuts         = shortcuts
       @tunnels           = tunnels
+
+      if @cluster_name.nil? && @spot_request_id.nil?
+        raise "Must specify either cluster_name or spot_request_id"
+      end
       self
     end
 
@@ -71,7 +78,7 @@ module KnuckleCluster
 
     private
 
-    attr_reader :cluster_name, :region, :bastion, :rsa_key_location, :ssh_username,
+    attr_reader :cluster_name, :spot_request_id, :region, :bastion, :rsa_key_location, :ssh_username,
                 :sudo, :aws_vault_profile, :shortcuts, :tunnels
 
     def select_agent(auto:)
@@ -79,14 +86,7 @@ module KnuckleCluster
 
       puts "\nListing Agents"
 
-      tp agents,
-         :index,
-         :instance_id,
-         # :public_ip,
-         # :private_ip,
-         # :availability_zone,
-         { task: { display_method: 'tasks.name', width: 999 } },
-         { container: { display_method: 'tasks.containers.name', width: 999 } }
+      output_agents
 
       puts "\nConnect to which agent?"
       agents[STDIN.gets.strip.to_i - 1]
@@ -185,12 +185,21 @@ module KnuckleCluster
     end
 
     def agent_registry
-      @agent_registry ||= AgentRegistry.new(
-        aws_client_config: aws_client_config,
-        cluster_name:      cluster_name,
+      @agent_registry ||= (
+        if @cluster_name
+          EcsAgentRegistry.new(
+            aws_client_config: aws_client_config,
+            cluster_name:      cluster_name,
+          )
+        elsif @spot_request_id
+          SpotRequestInstanceRegistry.new(
+            aws_client_config: aws_client_config,
+            spot_request_id:   spot_request_id,
+          )
+        end
       )
     end
 
-    def_delegators :agent_registry, :agents, :tasks, :containers
+    def_delegators :agent_registry, :agents, :tasks, :containers, :output_agents
   end
 end

data/lib/knuckle_cluster/agent.rb

@@ -6,8 +6,8 @@ module KnuckleCluster
       public_ip:,
       private_ip:,
       availability_zone:,
-      container_instance_arn:,
-      task_registry:
+      container_instance_arn: nil,
+      task_registry: nil
     )
       @index = index
       @instance_id = instance_id

data/lib/knuckle_cluster/{agent_registry.rb → ecs_agent_registry.rb}

@@ -4,7 +4,7 @@ require 'knuckle_cluster/task_registry'
 require 'forwardable'
 
 module KnuckleCluster
-  class AgentRegistry
+  class EcsAgentRegistry
     extend Forwardable
 
     def initialize(aws_client_config:, cluster_name:)
@@ -20,6 +20,17 @@ module KnuckleCluster
       agents_by_container_instance_arn[container_instance_arn]&.first
     end
 
+    def output_agents
+      tp agents,
+        :index,
+        :instance_id,
+        # :public_ip,
+        # :private_ip,
+        # :availability_zone,
+        { task: { display_method: 'tasks.name', width: 999 } },
+        { container: { display_method: 'tasks.containers.name', width: 999 } }
+    end
+
     def_delegators :task_registry, :tasks, :containers
 
     private

data/lib/knuckle_cluster/spot_request_instance_registry.rb

@@ -0,0 +1,53 @@
+require 'knuckle_cluster/agent'
+
+require 'forwardable'
+
+module KnuckleCluster
+  class SpotRequestInstanceRegistry
+    extend Forwardable
+
+    def initialize(aws_client_config:, spot_request_id:)
+      @aws_client_config = aws_client_config
+      @spot_request_id   = spot_request_id
+    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, :spot_request_id
+
+    def load_agents
+      spot_fleet_instances = ec2_client.describe_spot_fleet_instances(spot_fleet_request_id: spot_request_id)
+      instance_ids = spot_fleet_instances.active_instances.map(&: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
+
+  end
+end

data/lib/knuckle_cluster/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knuckle_cluster
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Envato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-18 00:00:00.000000000 Z
+date: 2017-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,9 +103,10 @@ files:
 - knuckle_cluster.gemspec
 - lib/knuckle_cluster.rb
 - lib/knuckle_cluster/agent.rb
-- lib/knuckle_cluster/agent_registry.rb
 - lib/knuckle_cluster/configuration.rb
 - lib/knuckle_cluster/container.rb
+- lib/knuckle_cluster/ecs_agent_registry.rb
+- lib/knuckle_cluster/spot_request_instance_registry.rb
 - lib/knuckle_cluster/task.rb
 - lib/knuckle_cluster/task_registry.rb
 - lib/knuckle_cluster/version.rb