knuckle_cluster 1.4.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78dfb68000ce016055de2e6a637eba4ac1f0c1e5
-  data.tar.gz: 921123b27124c87bdfd3c3c7c31a7f7073db1e8a
+  metadata.gz: 59963fda23e1d0884eac11bf2a2847143e401bdc
+  data.tar.gz: d928d2f5075505884aa89f32ebbdb62acd66b0a9
 SHA512:
-  metadata.gz: ad430a1a5c47d5674c3dccf646c7dfe315618733680d1b2946f4391cb63e02b5097887335b52ffc88408470f31c4b1f6395ff2e1c49bbabaa0c5da760aa5c63b
-  data.tar.gz: 1f21a272f73cf5815c3e4eaed44e367c30df0f443feb89150634e63ae05173e523bbea14a996c937398d8b639ff6c202c9fdac3a20a3b9add941b94b161c0e17
+  metadata.gz: ba13719e348fd5fa75ed0de38820e37e1629d3992c747e5a9d61a2f9ec71550923b3b1ce98671749b1bf329be615caa826a4f57fbafc1a40597312b3fa97791d
+  data.tar.gz: c42358f506487275be118c2654f58167fc0233a6c366c9ec39e1597e4bebcd691688cc17c0988310c1ede496dcbee305adf2af5778fd2237319627d911ab8350

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [2.0.0] - 2018-03-27
+Refactor SCP implementation to use new syntax
+Allow SCP copy files FROM agents or containers

data/README.md

@@ -102,6 +102,7 @@ knuckle_cluster CLUSTER_PROFILE logs CONTAINER_NAME - tail the logs for a contai
 knuckle_cluster CLUSTER_PROFILE CONTAINER_NAME [OPTIONAL COMMANDS] - connect to a container and start a shell or run a command
 knuckle_cluster CLUSTER_PROFILE SHORTCUT_NAME - run a shortcut defined in your knuckle_cluster configuration
 knuckle_cluster CLUSTER_PROFILE tunnel TUNNEL_NAME - open a tunnel defined in your knuckle_cluster configuration
+knuckle_cluster CLUSTER_PROFILE scp source destination - copied a file via scp to or from a container or agent. Use container:<location> or agent:<location>
 ```
 
 ### Rakefile usage
@@ -203,6 +204,22 @@ If you wish to see what instances are running within a spot fleet, KnuckleCluste
 ## 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).
 
+## SCP
+You can use Knuckle Cluster to copy files in and out of agents or containers.  Note that this will only work where one of the source or destination is your local machine, copying between containers is not yet supported.  Use a syntax similar to existing `scp` syntax when specifying a source or destination, but use the keyword `container` or `agent` for the remote. When using one of these keywords, you will be prompted as to which agent/container you wish to use.
+```
+#Copy some_file.txt into a container at /app/some_file.txt
+knuckle_cluster super_platform scp ./some_file.txt container:/app/some_file.txt
+
+#Copy /app/some_file.txt from a remote container to ./some_file.txt on your local machine
+knuckle_cluster super_platform scp container:/app/some_file.txt ./some_file.txt
+
+#Copy some_file.txt into an agent at ~/some_file.txt
+knuckle_cluster super_platform scp ./some_file.txt agent:~/some_file.txt
+
+#Copy /app/some_file.txt from a remote container to ./some_file.txt on your local machine
+knuckle_cluster super_platform scp agent:~/some_file.txt ./some_file.txt
+```
+
 ## Maintainer
 [Envato](https://github.com/envato)
 

data/bin/knuckle_cluster

@@ -12,7 +12,7 @@ if ARGV.count < 2
     knuckle_cluster CLUSTER_PROFILE CONTAINER_NAME [OPTIONAL COMMANDS] - connect to a container and start a shell or run a command
     knuckle_cluster CLUSTER_PROFILE SHORTCUT_NAME - run a shortcut defined in your knuckle_cluster configuration
     knuckle_cluster CLUSTER_PROFILE tunnel TUNNEL_NAME - open a tunnel defined in your knuckle_cluster configuration
-    knuckle_cluster CLUSTER_PROFILE scp [agent|container] source_file destination - copies a file from your local machine to a destaination container or agent
+    knuckle_cluster CLUSTER_PROFILE scp source destination - copied a file via scp to or from a container or agent. Use container:<location> or agent:<location>
   USAGE
   exit
 end
@@ -37,11 +37,7 @@ elsif ARGV[1] == 'logs'
 elsif ARGV[1] == 'tunnel'
   kc.open_tunnel(name: ARGV[2])
 elsif ARGV[1] == 'scp'
-  if ARGV[2] == 'agent'
-    kc.scp_to_agent(source: ARGV[3], destination: ARGV[4])
-  elsif ARGV[2] == 'container'
-    kc.scp_to_container(source: ARGV[3], destination: ARGV[4])
-  end
+  kc.initiate_scp(source: ARGV[2], destination: ARGV[3])
 else
   command = ARGV.drop(2)
   if command.any?

data/knuckle_cluster.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake",    "~> 10.0"
   spec.add_development_dependency "rspec",   "~> 3.0"
+  spec.add_development_dependency "pry",     "~> 0.11"
 
   spec.add_dependency 'aws-sdk-core',        '~> 3'
   spec.add_dependency 'aws-sdk-ec2',         '~> 1'

data/lib/knuckle_cluster.rb

@@ -1,6 +1,7 @@
 require 'knuckle_cluster/asg_instance_registry'
 require 'knuckle_cluster/ecs_agent_registry'
 require 'knuckle_cluster/spot_request_instance_registry'
+require "knuckle_cluster/scp"
 require "knuckle_cluster/version"
 require "knuckle_cluster/configuration"
 
@@ -16,6 +17,8 @@ module KnuckleCluster
   class << self
     extend Forwardable
 
+    include Scp
+
     def new(
         cluster_name: nil,
         spot_request_id: nil,
@@ -68,27 +71,6 @@ module KnuckleCluster
       run_command_in_container(container: container, command: command)
     end
 
-    def scp_to_agent(source:, destination:, agent: nil)
-      agent ||= select_agent
-      target_ip = bastion ? agent.private_ip : agent.public_ip
-      command = generate_scp_connection_string(agent: agent)
-      command += " #{source}"
-      command += " #{ssh_username}@#{target_ip}:#{destination}"
-      system(command)
-      puts "Done!"
-    end
-
-    def scp_to_container(source:, destination:)
-      container = select_container
-      agent     = container.task.agent
-      tmp_destination_file = '~/tmp_kc.tmp'
-      scp_to_agent(source: source, agent: agent, destination: tmp_destination_file)
-      container_id = get_container_id_command(container.name)
-      subcommand = "#{'sudo ' if sudo}docker cp #{tmp_destination_file} \\`#{container_id}\\`:#{destination} && rm #{tmp_destination_file}"
-      run_command_in_agent(agent: agent, command: subcommand)
-      puts "Done!"
-    end
-
     def container_logs(name:)
       container = find_container(name: name)
       subcommand = "#{'sudo ' if sudo}docker logs -f \\`#{get_container_id_command(container.name)}\\`"
@@ -203,14 +185,6 @@ module KnuckleCluster
       end
     end
 
-    def generate_scp_connection_string(agent:)
-      ip = bastion ? agent.private_ip : agent.public_ip
-      command = "scp"
-      command += " -i #{rsa_key_location}" if rsa_key_location
-      command += " -o ProxyCommand='ssh -qxT #{bastion} nc #{ip} 22'" if bastion
-      command
-    end
-
     def generate_connection_string(agent:, subcommand: nil, port_forward: nil)
       ip = bastion ? agent.private_ip : agent.public_ip
       command = "ssh #{ip} -l#{ssh_username}"

data/lib/knuckle_cluster/scp.rb

@@ -0,0 +1,81 @@
+module KnuckleCluster
+  module Scp
+    def initiate_scp(source:, destination:)
+      if source.start_with?('agent') || destination.start_with?('agent')
+        agent = select_agent
+
+        if source.start_with?('agent')
+          source      = generate_agent_scp_string(source,      agent)
+        elsif destination.start_with?('agent')
+          destination = generate_agent_scp_string(destination, agent)
+        end
+
+        scp_with_agent(source: source, destination: destination, agent: agent)
+      elsif source.start_with?('container') || destination.start_with?('container')
+        container = select_container
+        agent     = container.task.agent
+        if source.start_with?('container')
+          #This is SCP FROM container
+          source = source.split(':').last
+          tmp_source_file = '~/tmp_kc.tmp'
+          container_id = get_container_id_command(container.name)
+
+          subcommand = "#{'sudo ' if sudo}docker cp \\`#{container_id}\\`:#{source} #{tmp_source_file}"
+          run_command_in_agent(agent: agent, command: subcommand)
+
+          scp_source = generate_agent_scp_string(tmp_source_file, agent)
+          scp_with_agent(source: scp_source, agent: agent, destination: destination)
+
+          subcommand = "#{'sudo ' if sudo} rm #{tmp_source_file}"
+          run_command_in_agent(agent: agent, command: subcommand)
+
+          puts "Done!"
+        elsif destination.start_with?('container')
+          #SCP TO container
+          destination = destination.split(':').last
+          tmp_destination_file = '~/tmp_kc.tmp'
+          tmp_destination = generate_agent_scp_string(tmp_destination_file, agent)
+          scp_with_agent(source: source, agent: agent, destination: tmp_destination)
+          container_id = get_container_id_command(container.name)
+          subcommand = "#{'sudo ' if sudo}docker cp #{tmp_destination_file} \\`#{container_id}\\`:#{destination} && rm #{tmp_destination_file}"
+          run_command_in_agent(agent: agent, command: subcommand)
+          puts "Done!"
+        end
+      end
+    end
+
+    def generate_agent_scp_string(input, agent)
+      split_input = input.split(':')
+      location    = split_input.last
+      target_ip = bastion ? agent.private_ip : agent.public_ip
+      return "#{ssh_username}@#{target_ip}:#{location}"
+    end
+
+    def scp_with_agent(source:, destination:, agent: nil)
+      command = generate_scp_connection_string(agent: agent)
+      command += " #{source}"
+      command += " #{destination}"
+      system(command)
+      puts "Done!"
+    end
+
+    def generate_scp_connection_string(agent:)
+      ip = bastion ? agent.private_ip : agent.public_ip
+      command = "scp"
+      command += " -i #{rsa_key_location}" if rsa_key_location
+      command += " -o ProxyCommand='ssh -qxT #{bastion} nc #{ip} 22'" if bastion
+      command
+    end
+
+    def scp_to_container(source:, destination:)
+      container = select_container
+      agent     = container.task.agent
+      tmp_destination_file = '~/tmp_kc.tmp'
+      scp_to_agent(source: source, agent: agent, destination: tmp_destination_file)
+      container_id = get_container_id_command(container.name)
+      subcommand = "#{'sudo ' if sudo}docker cp #{tmp_destination_file} \\`#{container_id}\\`:#{destination} && rm #{tmp_destination_file}"
+      run_command_in_agent(agent: agent, command: subcommand)
+      puts "Done!"
+    end
+  end
+end

data/lib/knuckle_cluster/version.rb

@@ -1,3 +1,3 @@
 module KnuckleCluster
-  VERSION = '1.4.0'
+  VERSION = '2.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knuckle_cluster
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Envato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-12 00:00:00.000000000 Z
+date: 2018-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
   requirement: !ruby/object:Gem::Requirement
@@ -134,6 +148,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -149,6 +164,7 @@ files:
 - lib/knuckle_cluster/configuration.rb
 - lib/knuckle_cluster/container.rb
 - lib/knuckle_cluster/ecs_agent_registry.rb
+- lib/knuckle_cluster/scp.rb
 - lib/knuckle_cluster/spot_request_instance_registry.rb
 - lib/knuckle_cluster/task.rb
 - lib/knuckle_cluster/task_registry.rb