elasticsearch-drain 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 53c5321ac669ce1bf6ca87ed31a698e36e60d2c8
+  data.tar.gz: b252c88074cb2fb623c4de01b4991b7bac8da95c
+SHA512:
+  metadata.gz: 2d81aec24db08902298fe06dc33a72738e426d5b0f560e9dcf53fe8ea4acbca5fbe6a329136587dbed255a49a410431faf290fa2e0681510011cef4d17256b49
+  data.tar.gz: 7400aebaa436eeb4f52d24f9c13bc221cd8ec4ff0b39ba585c8b508c200792a82aa4ea7d1608008e47d453691220e23152128857c6bf84a4e797fd4262ab184c

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/test/tmp/
+es_client.log*

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,88 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2015-11-03 12:49:27 -0500 using RuboCop version 0.34.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Lint/AmbiguousRegexpLiteral:
+  Exclude:
+    - 'test/elasticsearch/drain/test_autoscaling.rb'
+
+# Offense count: 2
+Lint/ParenthesesAsGroupedExpression:
+  Exclude:
+    - 'test/elasticsearch/drain/test_cluster.rb'
+    - 'test/elasticsearch/test_drain.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'lib/elasticsearch/drain/nodes.rb'
+
+# Offense count: 1
+Metrics/AbcSize:
+  Max: 63
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+# Offense count: 16
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 125
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 12
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/CommentIndentation:
+  Exclude:
+    - 'test/test_helper.rb'
+
+# Offense count: 8
+# Configuration parameters: Exclude.
+Style/Documentation:
+  Exclude:
+    - 'lib/elasticsearch/drain.rb'
+    - 'lib/elasticsearch/drain/autoscaling.rb'
+    - 'lib/elasticsearch/drain/base.rb'
+    - 'lib/elasticsearch/drain/cli.rb'
+    - 'lib/elasticsearch/drain/cluster.rb'
+    - 'lib/elasticsearch/drain/node.rb'
+    - 'lib/elasticsearch/drain/nodes.rb'
+    - 'lib/elasticsearch/drain/version.rb'
+    - 'test/**/*'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/EmptyLinesAroundClassBody:
+  Exclude:
+    - 'lib/elasticsearch/drain/autoscaling.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredDelimiters.
+Style/PercentLiteralDelimiters:
+  Exclude:
+    - 'elasticsearch-drain.gemspec'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
+Style/RegexpLiteral:
+  Exclude:
+    - 'lib/elasticsearch/drain/node.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/UnneededPercentQ:
+  Exclude:
+    - 'elasticsearch-drain.gemspec'

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.3 
+  - 2.1.5
+  - 2.1.6
+  - 2.2.0
+  - 2.2.1
+  - 2.2.2
+sudo: false

data/Gemfile

@@ -0,0 +1,22 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in elasticsearch-drain.gemspec
+gemspec
+
+group :development do
+  gem 'rubyzip', '~> 1.1'
+  gem 'elasticsearch-extensions', '0.0.18'
+  gem 'yard', '~> 0.8'
+  gem 'thor', '~> 0.19.1'
+  gem 'thor-scmversion', '= 1.7.0'
+  gem 'guard'
+  gem 'guard-minitest'
+end
+
+group :development, :test do
+  gem 'minitest', '~> 5.8'
+  gem 'rubocop', '~> 0.34'
+  gem 'simplecov', '~> 0.10'
+  gem 'vcr', '~> 2.9'
+  gem 'webmock', '~> 1.21'
+end

data/Gemfile.lock

@@ -0,0 +1,129 @@
+PATH
+  remote: .
+  specs:
+    elasticsearch-drain (0.0.1)
+      aws-sdk (~> 2)
+      elasticsearch (~> 1.0)
+      thor (~> 0.19)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.8)
+    ansi (1.5.0)
+    ast (2.1.0)
+    astrolabe (1.3.1)
+      parser (~> 2.2)
+    aws-sdk (2.1.30)
+      aws-sdk-resources (= 2.1.30)
+    aws-sdk-core (2.1.30)
+      jmespath (~> 1.0)
+    aws-sdk-resources (2.1.30)
+      aws-sdk-core (= 2.1.30)
+    coderay (1.1.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    docile (1.1.5)
+    elasticsearch (1.0.14)
+      elasticsearch-api (= 1.0.14)
+      elasticsearch-transport (= 1.0.14)
+    elasticsearch-api (1.0.14)
+      multi_json
+    elasticsearch-extensions (0.0.18)
+      ansi
+      ruby-prof
+    elasticsearch-transport (1.0.14)
+      faraday
+      multi_json
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    ffi (1.9.10)
+    formatador (0.2.5)
+    guard (2.13.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, <= 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-minitest (2.4.4)
+      guard-compat (~> 1.2)
+      minitest (>= 3.0)
+    hashdiff (0.2.2)
+    jmespath (1.1.3)
+    json (1.8.3)
+    listen (3.0.3)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.9)
+    method_source (0.8.2)
+    minitest (5.8.1)
+    mixlib-shellout (2.2.3)
+    multi_json (1.11.2)
+    multipart-post (2.0.0)
+    nenv (0.2.0)
+    notiffany (0.0.8)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parser (2.2.3.0)
+      ast (>= 1.1, < 3.0)
+    powerpack (0.1.1)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rainbow (2.0.0)
+    rake (10.4.2)
+    rb-fsevent (0.9.6)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    rubocop (0.34.2)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.2.5, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-prof (0.15.8)
+    ruby-progressbar (1.7.5)
+    rubyzip (1.1.7)
+    safe_yaml (1.0.4)
+    shellany (0.0.1)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    thor (0.19.1)
+    thor-scmversion (1.7.0)
+      mixlib-shellout
+      thor
+    vcr (2.9.3)
+    webmock (1.22.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  elasticsearch-drain!
+  elasticsearch-extensions (= 0.0.18)
+  guard
+  guard-minitest
+  minitest (~> 5.8)
+  rake (~> 10.0)
+  rubocop (~> 0.34)
+  rubyzip (~> 1.1)
+  simplecov (~> 0.10)
+  thor (~> 0.19.1)
+  thor-scmversion (= 1.7.0)
+  vcr (~> 2.9)
+  webmock (~> 1.21)
+  yard (~> 0.8)

data/Guardfile

@@ -0,0 +1,42 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard :minitest do
+  # with Minitest::Unit
+  watch(%r{^test/(.*)\/?test_(.*)\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+
+  # with Minitest::Spec
+  # watch(%r{^spec/(.*)_spec\.rb$})
+  # watch(%r{^lib/(.+)\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
+  # watch(%r{^spec/spec_helper\.rb$}) { 'spec' }
+
+  # Rails 4
+  # watch(%r{^app/(.+)\.rb$})                               { |m| "test/#{m[1]}_test.rb" }
+  # watch(%r{^app/controllers/application_controller\.rb$}) { 'test/controllers' }
+  # watch(%r{^app/controllers/(.+)_controller\.rb$})        { |m| "test/integration/#{m[1]}_test.rb" }
+  # watch(%r{^app/views/(.+)_mailer/.+})                   { |m| "test/mailers/#{m[1]}_mailer_test.rb" }
+  # watch(%r{^lib/(.+)\.rb$})                               { |m| "test/lib/#{m[1]}_test.rb" }
+  # watch(%r{^test/.+_test\.rb$})
+  # watch(%r{^test/test_helper\.rb$}) { 'test' }
+
+  # Rails < 4
+  # watch(%r{^app/controllers/(.*)\.rb$}) { |m| "test/functional/#{m[1]}_test.rb" }
+  # watch(%r{^app/helpers/(.*)\.rb$})     { |m| "test/helpers/#{m[1]}_test.rb" }
+  # watch(%r{^app/models/(.*)\.rb$})      { |m| "test/unit/#{m[1]}_test.rb" }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Andrew Thompson, Rapid7 LLC.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,89 @@
+# Elasticsearch Drain
+
+The purpose of this utility is to drain documents from Elasticsearch nodes in an AutoScaling Group.
+
+This will help you do Elasticsearch node replacement while keeping the cluster healthy.  This is useful if you want to change the instance type of your nodes, or if you use custom AMIs and need to rollout a new AMI.
+
+Consider the following deployment procedure:
+ * Start with an AutoScaling Group with Elasticsearch nodes in a cluster
+ * Create a new AutoScaling Group with Elasticsearch nodes that join the above cluster
+ * Drain all data off older AutoScaling Group and remove instances from the AutoScaling Group and terminate instances
+
+
+## How does it work?
+1. Get the list of instances we want to remove from the cluster
+  * In this case it's an entire AutoScaling Group
+2. Ask the cluster for the `_id`(s) of those instances
+3. Then, tell the cluster to exclude these nodes from routing, which effectively removes all documents from the nodes
+4. Loop on these nodes asking the cluster how many documents each node is storing, when one reaches 0 we move on to the next step
+5. Remove the instance from the AutoScaling Group
+6. Terminate the instance
+7. Wait a moment and go back to step 4 and continue until there are 0 instances in the AutoScaling Group
+
+
+## Installation
+```bash
+$ gem install elasticsearch-drain
+```
+
+## Usage
+
+1. Create a new AutoScaling Group and populate with the same number of instances as the previous AutoScaling Group
+2. Run the tool, to start draining:
+```bash
+$ drain asg --asg="test-asg-0" --region="us-east-1" --host="localhost:9200"
+```
+
+## What's next?
+ * Remove a single node from the cluster
+ * Drain only mode
+
+
+## Testing
+Install all dependencies:
+```bash
+gem install bundler
+bundle install
+```
+
+Run test tests (unit and style):
+```bash
+rake
+```
+Or on a tight loop with guard:
+```bash
+bundle exec guard
+```
+
+If you need to make a new http request or refresh the fixtures you will need to start a test cluster.
+
+By default the test cluster install is version `1.7.2`, this can be changed by setting the `ES_VERSION` enviroment variable.
+
+Install and Start the Cluster:
+```bash
+rake elasticsearch:install elasticsearch:start
+```
+
+Run the tests:
+```bash
+rake test
+```
+
+Stop the Cluster:
+```bash
+rake elasticsearch:stop
+```
+
+And, to wrap all that up:
+```bash
+rake refresh_fixtures
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/rapid7/elasticsearch-drain/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,73 @@
+require 'elasticsearch/extensions/test/cluster/tasks'
+require 'elasticsearch/extensions/test/cluster'
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rake/testtask'
+require 'net/https'
+require 'fileutils'
+require 'zip'
+
+RuboCop::RakeTask.new
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/test_*.rb'
+end
+
+def elasticsearch_command
+  path = "tmp/elasticsearch-#{ENV['ES_VERSION']}/bin/elasticsearch"
+  path = ::File.expand_path(path, __dir__)
+  "bash #{path}"
+end
+
+ENV['TEST_CLUSTER_NODES'] = '1'
+ENV['TEST_CLUSTER_COMMAND'] = elasticsearch_command
+ENV['ES_VERSION'] ||= '1.7.2'
+
+namespace :elasticsearch do
+  task :clean do
+    next if File.exist? 'tmp/es.lock'
+    FileUtils.rm_rf 'tmp'
+  end
+
+  directory 'tmp'
+
+  task :install_lock do
+    FileUtils.touch 'tmp/es.lock'
+  end
+
+  # based on http://snippets.dzone.com/posts/show/2469
+  # http://farm1.static.flickr.com/92/218926700_ecedc5fef7_o.jpg
+  desc 'Download/extract Elasticsearch archive'
+  task download: [:tmp] do
+    next if File.exist? 'tmp/es.lock'
+    Net::HTTP.start('download.elastic.co') do |http|
+      resp = http.get("/elasticsearch/elasticsearch/elasticsearch-#{ENV['ES_VERSION']}.zip")
+      open('tmp/es.zip', 'w') { |file| file.write(resp.body) }
+    end
+  end
+
+  task :extract do
+    next if File.exist? 'tmp/es.lock'
+    Zip::File.open('tmp/es.zip') do |zip_file|
+      # Handle entries one by one
+      zip_file.each do |entry|
+        # Extract to file/directory/symlink
+        puts "Extracting #{entry.name}"
+        entry.extract(::File.join('tmp', entry.name))
+      end
+    end
+  end
+
+  desc 'Install a test Elasticsearch Cluster in project directory'
+  task install: [:clean, :download, :extract, :install_lock]
+end
+
+desc 'Start/Stop Elasticsearch Cluster to refresh test fixtures'
+task refresh_fixtures: ['elasticsearch:install',
+                        'elasticsearch:start',
+                        'test',
+                        'elasticsearch:stop']
+
+desc 'Run unit and style tests'
+task default: [:test, :rubocop]

data/Thorfile

@@ -0,0 +1,3 @@
+require 'bundler'
+require 'bundler/setup'
+require 'thor/scmversion'

data/bin/drain

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require_relative File.join(File.expand_path('../../lib', __FILE__), 'elasticsearch/drain')
+::Elasticsearch::Drain::CLI.start(ARGV)

data/elasticsearch-drain.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'elasticsearch/drain/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'elasticsearch-drain'
+  spec.version       = Elasticsearch::Drain::VERSION
+  spec.authors       = ['Andrew Thompson']
+  spec.email         = ['Andrew_Thompson@rapid7.com']
+  spec.summary       = %q{Elasticsearch node replacement utility that tries to keep the cluster healthy}
+  spec.description   = %q{The purpose of this utility is to drain documents from Elasticsearch nodes in an AutoScaling Group}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_dependency 'elasticsearch', '~> 1.0'
+  spec.add_dependency 'aws-sdk', '~> 2'
+  spec.add_dependency 'thor', '~> 0.19'
+end

data/lib/elasticsearch/drain/autoscaling.rb

@@ -0,0 +1,85 @@
+module Elasticsearch
+  class Drain
+    class AutoScaling
+
+      # @attribute [r]
+      # EC2 AutoScaling Group name
+      attr_reader :asg
+
+      # @attribute [r]
+      # EC2 Client
+      attr_reader :ec2_client
+
+      def initialize(asg, region)
+        @asg = asg
+        @asg_client = Aws::AutoScaling::Client.new(region: region)
+        @ec2_client = Aws::EC2::Client.new(region: region)
+        @instances = nil
+        @instance_ids = nil
+      end
+
+      def find_instances_in_asg
+        instances = []
+        @asg_client.describe_auto_scaling_instances.each do |page|
+          instances << page.auto_scaling_instances.map do |i|
+            i.instance_id if i.auto_scaling_group_name == asg
+          end
+        end
+        instances.flatten!
+        instances.compact!
+        @instance_ids = instances
+      end
+
+      def describe_instances
+        instances = []
+        find_instances_in_asg if @instance_ids.nil?
+        return [] if @instance_ids.empty?
+        @ec2_client.describe_instances(instance_ids: @instance_ids).each do |page|
+          instances << page.reservations.map(&:instances)
+        end
+        instances.flatten!
+        @instances = instances
+      end
+
+      def find_private_ips
+        instances = describe_instances.clone
+        return [] if instances.nil?
+        instances.map!(&:private_ip_address)
+        instances.flatten!
+        instances
+      end
+
+      def instances
+        find_instances_in_asg
+        find_private_ips
+      end
+
+      def instance(ipaddress)
+        describe_instances if @instances.nil?
+        instances = @instances.clone
+        instances.find { |i| i.private_ip_address == ipaddress }
+      end
+
+      # Sets the MinSize of an AutoScalingGroup
+      #
+      # @option [FixNum] count (0) The new MinSize of the AutoScalingGroup
+      # @return [Struct] Empty response from the sdk
+      def min_size(count = 0)
+        @asg_client.update_auto_scaling_group(
+          auto_scaling_group_name: asg,
+          min_size: count
+        )
+      end
+
+      def detach_instance(instance_id)
+        resp = @asg_client.detach_instances(
+          instance_ids: [instance_id],
+          auto_scaling_group_name: asg,
+          should_decrement_desired_capacity: true
+        )
+        resp.activities.first.status_code == 'Successful'
+      end
+    end
+  end
+end
+require 'aws-sdk'

data/lib/elasticsearch/drain/base.rb

@@ -0,0 +1,13 @@
+module Elasticsearch
+  class Drain
+    class Base
+      # @attribute [r]
+      # The Elasticsearch client object
+      attr_reader :client
+
+      def initialize(client)
+        @client = client
+      end
+    end
+  end
+end