elbtool 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fc09aa0abb9a97ca45b828af77d9fa090fbb77b3
+  data.tar.gz: 59c8ead9002d223ebcc626e0eafb40ec9d7d43f5
+SHA512:
+  metadata.gz: 99af78cc533e2078671ae821d17e463791f3f451d09b87352ab14bdada5b01acc1620a5e9515512e218ef6fef51cd1790e72ef08d7d5377f13b7bf2555891f8c
+  data.tar.gz: f0e7c6a2860b2d4b2e7255945a64ee360164880eff5f94f637c65c2c358810c456f4f15138593fc530e0e8b099ed863c71f6247b88d1cb95f17e44a1d8675ffe

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+LATEST_CHANGELOG.md
+.byebug_history

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,11 @@
+LineLength:
+  Max: 100
+
+MethodLength:
+  Max: 50
+
+AbcSize:
+  Max: 30
+
+Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in elbtool.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Eric Herot
+
+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,31 @@
+# Elbtool
+
+Register and deregister instance from an AWS ELB
+
+# Requirements
+
+* Instance must be a member of an IAM role with the proper permissions
+* `aws-sdk`
+
+# Usage
+
+Originally this was intended to be used by automatic reboot scripts to deregister instances before shutting them down, but it can also be triggered manually.
+
+Note that if you are **NOT** running on the EC2 instance you want to (de-)register, you will need to specify `--instance-id INSTANCE_ID`.
+
+## To register an instance
+
+```
+$ elbtool --register LOAD_BALANCER_NAME
+```
+
+## To de-register an instance
+
+```
+$ elbtool --deregister LOAD_BALANCER_NAME
+```
+
+## Other important options
+
+* `--register-timeout` -- Number of seconds to wait when registering an instance before giving up and returning an error. By default this is set to the health check `interval` times `healthy_threshold` (the number of times an instance must return a successful health check to be considered health) plus 15 seconds (for buffer)
+* `--deregister-timeout` -- Number of seconds to wait when de-registering an instance before giving up and returning an error. If connection draining is enabled, this waits for `connection_draining` + 5 seconds. If not, it just waits 5 seconds (for buffer).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "elbtool"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/elbtool.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'elbtool/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "elbtool"
+  spec.version       = Elbtool::VERSION
+  spec.authors       = ["Eric Herot"]
+  spec.email         = ["eric.github@herot.com"]
+
+  spec.summary       = %q{Register and reregister EC2 instances from an ELB}
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'aws-sdk'
+  spec.add_dependency 'trollop'
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "byebug"
+end

data/exe/elbtool

@@ -0,0 +1,3 @@
+require 'elbtool'
+
+Elbtool.run

data/lib/elbtool/version.rb

@@ -0,0 +1,3 @@
+class Elbtool
+  VERSION = '0.1.0'.freeze
+end

data/lib/elbtool.rb

@@ -0,0 +1,126 @@
+require 'elbtool/version'
+require 'trollop'
+require 'aws-sdk'
+require 'net/http'
+require 'byebug'
+
+class Elbtool
+  def self.run
+    Elbtool.new.run
+  end
+
+  def run
+    return register if opts[:register]
+    deregister
+    puts 'Done'
+  end
+
+  private
+
+  def register
+    elb.register_instances_with_load_balancer(
+      instances: [{ instance_id: instance_id }],
+      load_balancer_name: load_balancer_name
+    )
+
+    print 'Waiting for instance to become healthy...'
+
+    register_timeout.times do
+      return if instance_health.state == 'InService'
+      print '.'
+      sleep 1
+    end
+
+    h_o = instance_health
+
+    fail "Instance failed to enter state 'InService' within #{register_timeout} seconds \n" \
+         "(state: #{h_o.state}; reason_code: #{h_o.reason_code}; description: #{h_o.description})"
+  end
+
+  def deregister
+    elb.deregister_instances_from_load_balancer(
+      instances: [{ instance_id: instance_id }],
+      load_balancer_name: load_balancer_name
+    )
+
+    print 'Waiting for instance to deregister...'
+
+    deregister_timeout.times do
+      return unless instance_health
+      print '.'
+      sleep 1
+    end
+
+    h_o = instance_health
+
+    fail "Instance failed to deregister within #{deregister_timeout} seconds \n" \
+         "(state: #{h_o.state}; reason_code: #{h_o.reason_code}; description: #{h_o.description})"
+  end
+
+  def instance_id
+    @instance_id ||=
+      opts[:instance_id] || begin
+        uri = URI 'http://169.254.169.254/2016-06-30/meta-data/instance-id'
+        Net::HTTP.start(uri.host, uri.port, open_timeout: 1) { |http| http.get uri.path }.body
+      rescue Net::OpenTimeout
+        puts '`instance_id` could not be retrieved from instance metadata. Please specify ' \
+             '--instance-id if you are not running on an ec2 instance.'
+        exit 1
+      end
+  end
+
+  def instance_health
+    elb.describe_instance_health(load_balancer_name: load_balancer_name).instance_states.find do |i|
+      i['instance_id'] == instance_id
+    end
+  end
+
+  def elb
+    @elb ||= Aws::ElasticLoadBalancing::Client.new
+  end
+
+  def load_balancer_name
+    @load_balancer_name ||= (opts[:register] || opts[:deregister])
+  end
+
+  def register_timeout
+    @register_timeout ||= begin
+      return opts[:register_timeout] if opts[:register_timeout]
+      health_check_obj = elb.describe_load_balancers(
+        load_balancer_names: [load_balancer_name]
+      ).load_balancer_descriptions.first.health_check
+
+      # Base the register_timeout on the existing load balancer configuration
+      health_check_obj.interval * health_check_obj.healthy_threshold + 15
+    end
+  end
+
+  def deregister_timeout
+    @deregister_timeout ||= begin
+      return opts[:deregister_timeout] if opts[:deregister_timeout]
+      c_d = elb.describe_load_balancer_attributes(
+        load_balancer_name: load_balancer_name
+      ).load_balancer_attributes.connection_draining
+      (c_d.enabled ? c_d.timeout : 0) + 5
+    end
+  end
+
+  def opts
+    @opts ||= Trollop.options do
+      opt :register, 'Register node with the specified ELB', short: 'r', type: String
+      opt :deregister, 'De-register node from the specified ELB', short: 'd', type: String
+      opt :instance_id, 'Instance ID (retrieved from local metadata by default)',
+          short: 'i',
+          type: String
+      opt :register_timeout,
+          'Registration timeout in seconds (defaults to `interval` * `healthy_threshold` + 15)',
+          type: Integer
+      opt :deregister_timeout,
+          'De-registration timeout in seconds (defaults to `connection_draining` timeout + 5)',
+          type: Integer
+    end
+
+    return @opts if @opts[:register] || @opts[:deregister]
+    Trollop.die 'Please specify either --register or --deregister'
+  end
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: elbtool
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eric Herot
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  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: trollop
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- eric.github@herot.com
+executables:
+- elbtool
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- elbtool.gemspec
+- exe/elbtool
+- lib/elbtool.rb
+- lib/elbtool/version.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Register and reregister EC2 instances from an ELB
+test_files: []