elastic_beans 0.9.1 → 0.10.0.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c144928ae084c0496a67956390849f40aae25ed5
-  data.tar.gz: '019811a87002509e40108fdc1d8cc76ae8fa0777'
+  metadata.gz: 44f1c4f70c8a932819315f3d02623b75423ff299
+  data.tar.gz: 270d9d55029d816b5f45f91b13d2ff3e89e6b456
 SHA512:
-  metadata.gz: 5453396cb2fc49b0a58e06a824a37d4c985a93d8ac9d76cb430aba33323cf437063628c49cddc1b40ceadf1031522a020e5fb80caac29619e049700f68f0c797
-  data.tar.gz: 0d6cddec37f72a87367d4b3816b1a763fa86d0aebe5e4e21b50754df97854667890767b45fa2397d78afd2753b467f23f2b340df183e9b878b368c22f903ea37
+  metadata.gz: c9808cfe16431ef5bd7ac8df11ac31e85331d36c0fefb89d24c6aa95bd91ca593762e09db378c3913a29bd0dd4d732cc4e0b831aaf39645684cbd123cc720acc
+  data.tar.gz: e223d9b76c7b922dd3271958458e86a100eaf45842c47012b33de0d4b647fc405f68d009f56daa7cb9d37365dec7230181b93631240fb0bbf0de8a26daad345c

data/Gemfile

@@ -4,7 +4,6 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  gem "net-ssh-gateway"
   gem "rails", "~> 5.0"
   gem "rspec_junit_formatter"
   gem "timecop"

data/README.md

@@ -53,6 +53,10 @@ As the SDK documentation suggests, using environment variables is recommended.
     # Run one-off tasks
     beans exec -a myapp rake db:migrate
 
+    # SSH to an instance for debugging, tunneling through a bastion instance to reach the private network
+    beans ssh -a myapp webserver [-n INDEX] [-i IDENTITY_FILE] [-u USERNAME] \
+      [-b BASTION_HOST] [--bastion-identity-file BASTION_IDENTITY_FILE] [--bastion-username BASTION_USERNAME]
+
     # Update all existing environments and configuration
     beans configure -n myapp-networking -a myapp \
       [-b SECRET_KEY_BASE] [-d DATABASE_URL] [-k KEYPAIR] \

data/elastic_beans.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "aws-sdk", "~> 2.3"
   spec.add_dependency "nesty", "~> 1.0"
+  spec.add_dependency "net-ssh-gateway"
   spec.add_dependency "rails"
   spec.add_dependency "ruby-progressbar", "~> 1.2"
   spec.add_dependency "rubyzip", "~> 1.2"

data/lib/elastic_beans/cli.rb

@@ -200,6 +200,37 @@ class ElasticBeans::CLI < Thor
 
   map ["delvar", "rmvar"] => "unsetenv"
 
+  desc ElasticBeans::Command::Ssh::USAGE, ElasticBeans::Command::Ssh::DESC
+  long_desc ElasticBeans::Command::Ssh::LONG_DESC
+  option :application, aliases: %w(-a), required: true, desc: APPLICATION_DESC
+  option :bastion_host, aliases: %w(-b), desc: "The hostname of the bastion server in the VPC"
+  option :bastion_identity_file, desc: "The SSH private key to use to connect to the bastion server"
+  option :bastion_username, desc: "The username to use to connect to the bastion server"
+  option :identity_file, aliases: %w(-i), desc: "The SSH private key associated with the keypair used when creating the environment"
+  option :index, aliases: %w(-n), desc: "The 0-based index of the instance to connect to"
+  option :queue, aliases: %w(-q), desc: "The name of the queue to identify the worker environment to connect to, e.g. `default`"
+  option :username, aliases: %w(-u), desc: "The username to log into the instance with, e.g. `ec2-user`"
+  def ssh(environment_type)
+    @verbose = options[:verbose]
+    ElasticBeans::Command::Ssh.new(
+      application: application(
+        name: options[:application],
+      ),
+      bastion_host: options[:bastion_host],
+      bastion_identity_file: options[:bastion_identity_file],
+      bastion_username: options[:bastion_username],
+      identity_file: options[:identity_file],
+      index: options[:index],
+      queue: options[:queue],
+      username: options[:username],
+      ec2: ec2_client,
+      elastic_beanstalk: elastic_beanstalk_client,
+      ui: ui,
+    ).run(environment_type)
+  rescue StandardError => e
+    error(e)
+  end
+
   desc "talk", ""
   def talk
     ElasticBeans::Command::Talk.new(ui: ui).run
@@ -233,6 +264,10 @@ class ElasticBeans::CLI < Thor
     ::Aws::CloudFormation::Client.new
   end
 
+  def ec2_client
+    ::Aws::EC2::Client.new
+  end
+
   def elastic_beanstalk_client
     ::Aws::ElasticBeanstalk::Client.new
   end

data/lib/elastic_beans/command/create.rb

@@ -34,9 +34,7 @@ Requires AWS credentials to be set in the environment, i.e. AWS_ACCESS_KEY_ID an
       )
         @environment_type = environment_type
         @dns = dns
-        if @environment_type == "worker"
-          @queue = queue || "default"
-        end
+        @queue = queue
         @tags = tags
         @application = application
         @ui = ui

data/lib/elastic_beans/command/scale.rb

@@ -18,7 +18,7 @@ Requires AWS credentials to be set in the environment, i.e. AWS_ACCESS_KEY_ID an
         @application = application
         @minimum = minimum
         @maximum = maximum
-        @queue = queue || "default"
+        @queue = queue
         @elastic_beanstalk = elastic_beanstalk
         @ui = ui
       end

data/lib/elastic_beans/command/ssh.rb

@@ -0,0 +1,185 @@
+require "net/ssh/gateway"
+require "elastic_beans/error/environments_not_ready"
+
+module ElasticBeans
+  module Command
+    # :nodoc: all
+    class Ssh
+      USAGE = "ssh ENVIRONMENT_TYPE"
+      DESC = "Connect to an instance for debugging, tunneling through a bastion server"
+      LONG_DESC = <<-LONG_DESC
+Connect to an instance for debugging, tunneling through a bastion server.
+Opens a login shell.
+
+Requires AWS credentials to be set in the environment, i.e. AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY.
+      LONG_DESC
+
+      def initialize(
+        application:,
+        bastion_host:,
+        bastion_identity_file:,
+        bastion_username:,
+        identity_file:,
+        index:,
+        queue:,
+        username:,
+        ec2:,
+        elastic_beanstalk:,
+        ui:
+      )
+        @application = application
+        @bastion_host = bastion_host
+        @bastion_identity_file = bastion_identity_file
+        @bastion_username = bastion_username
+        @identity_file = identity_file
+        @index = index.to_i
+        @queue = queue
+        @username = username || "ec2-user"
+        @ec2 = ec2
+        @elastic_beanstalk = elastic_beanstalk
+        @ui = ui
+      end
+
+      def run(environment_type)
+        environment = ElasticBeans::Environment.new_by_type(
+          environment_type,
+          queue: queue,
+          application: application,
+          elastic_beanstalk: elastic_beanstalk,
+        )
+        instance_id = environment.instance_ids[index]
+        ui.debug { "In environment '#{environment.name}' found instance '#{instance_id}' at index '#{index}' of #{environment.instance_ids.inspect}" }
+        if instance_id.nil?
+          raise NoInstanceError.new(environment: environment, index: index)
+        end
+
+        begin
+          instance_ip = ec2.describe_instances(instance_ids: [instance_id]).reservations[0].instances[0].private_ip_address
+        rescue ::Aws::EC2::Errors::InvalidInstanceIDMalformed
+          raise NoInstanceError.new(environment: environment, index: index)
+        end
+        # It's possible a retry would just work, but I'd like to see this happen in reality before I assume that.
+        if instance_ip.nil?
+          raise TerminatedInstanceError.new(instance_id: instance_id, environment: environment)
+        end
+
+        ssh_args = ["ssh"]
+
+        if identity_file
+          ssh_args << "-i"
+          ssh_args << identity_file
+        end
+
+        gateway = nil
+        if bastion_host
+          ssh_args << "#{username}@localhost"
+          ssh_args += ["-o", "UserKnownHostsFile=/dev/null", "-o", "StrictHostKeyChecking=no"]
+          begin
+            bastion_options = {auth_methods: ["publickey"]}
+            if bastion_identity_file
+              bastion_options[:key_data] = File.read(bastion_identity_file)
+            end
+
+            ui.info("Connecting to '#{bastion_username}@#{bastion_host}'...")
+            gateway = Net::SSH::Gateway.new(
+              bastion_host,
+              bastion_username,
+              bastion_options
+            )
+            port = gateway.open(instance_ip, 22)
+            ui.debug { "Opened gateway to '#{instance_ip}' on port '#{port}'" }
+            ssh_args += ["-p", port.to_s]
+          rescue Net::SSH::AuthenticationFailed => e
+            raise BastionAuthenticationError.new(cause: e)
+          end
+        else
+          ssh_args << "#{username}@#{instance_ip}"
+        end
+
+        ui.info("Connecting to '#{username}@#{instance_ip}'...")
+        pid = Process.spawn(*ssh_args)
+        _, status = Process.waitpid2(pid)
+        unless status.success?
+          raise SshFailedError
+        end
+      ensure
+        gateway.close(port) if gateway
+      end
+
+      private
+
+      attr_reader(
+        :application,
+        :bastion_host,
+        :bastion_identity_file,
+        :bastion_username,
+        :identity_file,
+        :index,
+        :queue,
+        :username,
+        :ec2,
+        :elastic_beanstalk,
+        :ui,
+      )
+
+      class BastionAuthenticationError < ElasticBeans::Error
+        def initialize(cause:)
+          @cause = cause
+        end
+
+        def message
+          <<-MESSAGE
+#{@cause.message}
+
+Please check the --bastion-identity-file or --bastion-username options and try again.
+
+#{command_help "ssh"}
+          MESSAGE
+        end
+      end
+
+      class NoInstanceError < ElasticBeans::Error
+        def initialize(environment:, index:)
+          @environment = environment
+          @index = index
+        end
+
+        def message
+          msg = "The '#{@environment.name}' environment has no instance at index #{@index}.\n"
+          if @index > 0
+            msg << "Try again with a lower index.\n"
+          else
+            msg << "Wait for instances to be created and try again.\n"
+          end
+          msg << <<-MESSAGE
+
+#{command_help "ssh"}
+          MESSAGE
+          msg
+        end
+      end
+
+      class SshFailedError < ElasticBeans::Error
+        def message
+          ""
+        end
+      end
+
+      class TerminatedInstanceError < ElasticBeans::Error
+        def initialize(instance_id:, environment:)
+          @instance_id = instance_id
+          @environment = environment
+        end
+
+        def message
+          <<-MESSAGE
+The instance '#{@instance_id}' in the environment '#{@environment.name}' has been terminated.
+Please try again in a moment.
+
+#{command_help "ssh"}
+          MESSAGE
+        end
+      end
+    end
+  end
+end

data/lib/elastic_beans/command.rb

@@ -8,6 +8,7 @@ require "elastic_beans/command/scale"
 require "elastic_beans/command/get_env"
 require "elastic_beans/command/set_env"
 require "elastic_beans/command/unset_env"
+require "elastic_beans/command/ssh"
 require "elastic_beans/command/talk"
 require "elastic_beans/command/version"
 

data/lib/elastic_beans/environment/worker.rb

@@ -12,9 +12,9 @@ module ElasticBeans
 
       attr_reader :queue
 
-      def initialize(name, queue:, **_)
+      def initialize(name, queue: nil, **_)
         super
-        @queue = queue
+        @queue = queue || "default"
       end
 
       # Returns "worker"

data/lib/elastic_beans/environment.rb

@@ -40,7 +40,8 @@ module ElasticBeans
       when "webserver"
         ElasticBeans::Environment::Webserver.new(name, application: application, **args)
       when "worker"
-        name = "#{name}-#{args[:queue]}"
+        queue_name = args[:queue] || "default"
+        name = "#{name}-#{queue_name}"
         ElasticBeans::Environment::Worker.new(name, application: application, **args)
       else
         raise UnknownEnvironmentType.new(environment_type: type)
@@ -78,7 +79,6 @@ module ElasticBeans
           ElasticBeans::Environment::Worker.new(
             environment.environment_name,
             application: application,
-            queue: "default",
             **args,
           )
         else
@@ -211,6 +211,15 @@ module ElasticBeans
       environment.cname
     end
 
+    # Returns the instance IDs that are part of this environment.
+    #
+    # Raises an error if the environment does not exist.
+    def instance_ids
+      environment_resources.instances.map(&:id)
+    rescue ::Aws::ElasticBeanstalk::Errors::InvalidParameterValue
+      raise MissingEnvironmentError.new(environment: self, application: application)
+    end
+
     # Returns the status of the environment in Elastic Beanstalk.
     #
     # Raises an error if the environment does not exist.
@@ -242,6 +251,15 @@ module ElasticBeans
       retry
     end
 
+    def environment_resources
+      elastic_beanstalk.describe_environment_resources(
+        environment_name: name,
+      ).environment_resources
+    rescue ::Aws::ElasticBeanstalk::Errors::Throttling
+      sleep 5
+      retry
+    end
+
     def template_name
       TEMPLATE_NAME
     end
@@ -324,10 +342,13 @@ Please re-run `#{command_as_string "configure"}`.
 
       def message
         require "elastic_beans/command/create"
-        <<-MESSAGE
-Environment `#{@environment.name}' does not exist.
-Please run `#{command_as_string "create #{@environment.type} -a #{@application.name}"}`.
-        MESSAGE
+        msg = "Environment `#{@environment.name}' does not exist.\n"
+        msg << "Please run `#{command_as_string "create #{@environment.type}"}"
+        if @environment.respond_to?(:queue)
+          msg << " -q #{@environment.queue}"
+        end
+        msg << " -a #{@application.name}`.\n"
+        msg
       end
     end
 

data/lib/elastic_beans/version.rb

@@ -1,3 +1,3 @@
 module ElasticBeans
-  VERSION = "0.9.1"
+  VERSION = "0.10.0.alpha1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic_beans
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0.alpha1
 platform: ruby
 authors:
 - Adam Stegman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-10 00:00:00.000000000 Z
+date: 2017-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: net-ssh-gateway
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -186,6 +200,7 @@ files:
 - lib/elastic_beans/command/restart.rb
 - lib/elastic_beans/command/scale.rb
 - lib/elastic_beans/command/set_env.rb
+- lib/elastic_beans/command/ssh.rb
 - lib/elastic_beans/command/talk.rb
 - lib/elastic_beans/command/unset_env.rb
 - lib/elastic_beans/command/version.rb
@@ -232,12 +247,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Elastic Beanstalk environment orchestration for a Rails app