chef_ec2_node_rm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f65051bb01a78f95fcb647917c531790e0b0c2cd188273f082371c6cf4c13425
+  data.tar.gz: dcc336aaf1e627f84f09632fa7923732be51be35aa9a42e83b40db281a87f620
+SHA512:
+  metadata.gz: 7ef29f3f5a0f1fd4d6cc526f3467434cdedee818e6de1d13f592e9374f40a76d6ad9877c4ffaf252b5375f25b0dd8979c01f18f7b14278ee8b6d1ecdefb5dafd
+  data.tar.gz: caad41eedbacdefb78f38b1ad564f65e3162df9ea91366146fb31faac312613dc36cf3ee83003164e309d9cd1cf7fc43d50bd4fe57e5e907ba7b221ba5841f1f

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.5.0

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in chef_ec2_node_rm.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    chef_ec2_node_rm (0.1.0)
+      aws-sdk-sqs (~> 1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    aws-partitions (1.63.0)
+    aws-sdk-core (3.15.0)
+      aws-partitions (~> 1.0)
+      aws-sigv4 (~> 1.0)
+      jmespath (~> 1.0)
+    aws-sdk-sqs (1.3.0)
+      aws-sdk-core (~> 3)
+      aws-sigv4 (~> 1.0)
+    aws-sigv4 (1.0.2)
+    jmespath (1.3.1)
+    minitest (5.11.3)
+    minitest-autotest (1.0.3)
+      minitest-server (~> 1.0)
+    minitest-server (1.0.5)
+      minitest (~> 5.0)
+    parallel (1.12.1)
+    parser (2.5.0.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rubocop (0.52.1)
+      parallel (~> 1.10)
+      parser (>= 2.4.0.2, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    unicode-display_width (1.3.0)
+    yard (0.9.12)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  chef_ec2_node_rm!
+  minitest (~> 5.0)
+  minitest-autotest (~> 1.0)
+  rake (~> 10.0)
+  rubocop (~> 0.45)
+  yard (~> 0.9)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Mike Conigliaro
+
+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,97 @@
+# chef_ec2_node_rm
+
+If you're managing EC2 instances with a Chef server, this gem can help prevent your server from becoming polluted with stale node/client data by automatically deleting it whenever instances are destroyed.
+
+## AWS Credentials
+
+This gem relies on [aws-sdk](https://aws.amazon.com/sdk-for-ruby/), so AWS credentials will automatically be read from the usual places (credential files under `~/.aws`, environment variables, IAM roles, etc.).
+
+## Installation
+
+1. Create an SQS queue for your EC2 termination events.
+
+1. Create a CloudWatch event rule to send termination events to the SQS queue:
+
+    ```
+    {
+      "source": [
+        "aws.ec2"
+      ],
+      "detail-type": [
+        "EC2 Instance State-change Notification"
+      ],
+      "detail": {
+        "state": [
+          "terminated"
+        ]
+      }
+    }
+    ```
+
+1. [Configure knife](https://docs.chef.io/knife_setup.html) on your Chef server.
+
+1. Install `chef_ec2_node_rm` on your Chef server:
+
+    ```
+    gem install chef_ec2_node_rm
+    ```
+
+1. Run the application in the foreground to make sure everything is working (run it with `--help` to see a list of available options):
+
+    ```
+    chef_ec2_node_rm <options>
+    ```
+
+1. Using the command above, create an Upstart job on your Chef server (e.g. `/etc/systemd/system/chef_ec2_node_rm.service`) to keep the application running in the background:
+
+    ```
+    [Unit]
+    Description=chef_ec2_node_rm
+
+    [Service]
+    Type=simple
+    Environment=HOME=/root
+    ExecStart=/path/to/chef_ec2_node_rm <options>
+    Restart=always
+
+    [Install]
+    WantedBy=multi-user.target
+    ```
+
+1. Start the service:
+
+    ```
+    systemctl daemon-reload
+    systemctl restart chef_ec2_node_rm
+    ```
+
+## Development
+
+### Getting Started
+
+    ./bin/setup
+
+### Testing
+
+#### Running Tests
+
+    rake test
+    rake rubocop
+
+#### Example SQS Message
+
+    {
+      "detail": {
+        "instance-id": "foo",
+        "state": "bar"
+      }
+    }
+
+### Releases
+
+    gem build chef_ec2_node_rm.gemspec
+    gem install chef_ec2_node_rm-*.gem
+
+## Credits
+
+- Inspired by [Matt Revell's script](http://blog.mattrevell.net/2014/02/19/automatically-remove-dead-autoscale-nodes-from-chef-server/)

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.warning = false
+end
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'chef_ec2_node_rm'
+
+# 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(__FILE__)

data/bin/setup

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+gem install bundler --conservative
+bundle install

data/chef_ec2_node_rm.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chef_ec2_node_rm/meta'
+
+Gem::Specification.new do |spec|
+  spec.name = ChefEc2NodeRm::NAME
+  spec.version = ChefEc2NodeRm::VERSION
+  spec.authors = ChefEc2NodeRm::AUTHORS
+  spec.email = ChefEc2NodeRm::AUTHORS.map { |obj| obj.match(/<(.*?)>/)[1] }
+
+  spec.summary = 'Automatically delete chef node/client data on EC2'
+  spec.description = 'Automatically delete chef node/client data on EC2'
+  spec.homepage = ChefEc2NodeRm::URL
+  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_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'minitest-autotest', '~> 1.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.45'
+
+  spec.add_dependency 'aws-sdk-sqs', '~> 1.3'
+end

data/exe/chef_ec2_node_rm

@@ -0,0 +1,74 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'chef_ec2_node_rm'
+
+options = {
+  aws_sqs_instance_states: %w[terminated],
+  knife_search_attribute: 'ec2_instance_id',
+  log_level: 'info',
+  dry_run: false
+}
+OptionParser.new do |opts|
+  opts.version = ChefEc2NodeRm::VERSION
+  opts.banner = "Usage: #{File.basename($PROGRAM_NAME)} [options] <AWS SQS URL(s)>\n\n"
+
+  opts.on_tail('-s', '--aws-sqs-instance-states <state>[,<state>,...]', Array, "Deletes will be triggered for these instance states (default: #{options[:aws_sqs_instance_states].join(', ')})") do |opt|
+    options[:aws_sqs_instance_states] = opt
+  end
+
+  opts.on_tail('-d', '--dry-run', FalseClass, 'Show what will happen without actually deleting anything') do
+    options[:dry_run] = true
+  end
+
+  opts.on_tail('-h', '--help', 'Show this message') do
+    puts opts.help
+    exit
+  end
+
+  opts.on_tail('-a', '--knife-search-attribute <attribute>', String, "Instance ID attribute to use in knife search (default: #{options[:knife_search_attribute]})") do |opt|
+    options[:knife_search_attribute] = opt
+  end
+
+  opts.on_tail('-l', '--log-level <level>', String, "Log level (default: #{options[:log_level]})") do |opt|
+    options[:log_level] = opt
+  end
+
+  opts.on_tail('-v', '--version', 'Show version') do
+    puts format("#{opts.program_name} v#{opts.version}\n#{ChefEc2NodeRm::URL}\n#{ChefEc2NodeRm::AUTHORS.join("\n")}\n")
+    exit
+  end
+
+  if ARGV.length.zero?
+    puts opts.help
+    exit(1)
+  end
+end.parse!
+
+include ChefEc2NodeRm::Logging
+logger.level = Logger.const_get(options[:log_level].upcase)
+
+ChefEc2NodeRm::SqsPollers.new(ARGV).start do |poller, msg|
+  msg_parsed = ChefEc2NodeRm::SqsMessage.new(msg.body)
+  logger.info(Thread.current.name) { "Message received: id='#{msg.message_id}' instance_id='#{msg_parsed.instance_id}' state='#{msg_parsed.state}'" }
+
+  if options[:aws_sqs_instance_states].include?(msg_parsed.state)
+    search_results = ChefEc2NodeRm::Knife.new("search node '#{options[:knife_search_attribute]}:#{msg_parsed.instance_id}' --id-only").run
+    if search_results['results'].is_a?(Numeric) && search_results['rows'].respond_to?(:each)
+      logger.info("Found #{search_results['results']} Chef node(s) with instance_id: #{msg_parsed.instance_id}")
+      search_results['rows'].each do |name|
+        %w[node client].each do |type|
+          logger.info("Deleting #{type}: #{name}#{' (dry-run)' if options[:dry_run]}")
+          ChefEc2NodeRm::Knife.new("#{type} delete #{name} -y").run unless options[:dry_run]
+        end
+      end
+    else
+      logger.error("Knife search results are malformed: #{search_results}")
+    end
+  end
+
+  logger.info(Thread.current.name) { "Deleting message: id='#{msg.message_id}'#{' (dry-run)' if options[:dry_run]}" }
+  poller.delete_message(msg) unless options[:dry_run]
+end

data/lib/chef_ec2_node_rm.rb

@@ -0,0 +1,11 @@
+require 'aws-sdk-sqs'
+require 'json'
+require 'logger'
+
+require 'chef_ec2_node_rm/logging'
+
+require 'chef_ec2_node_rm/error'
+require 'chef_ec2_node_rm/knife'
+require 'chef_ec2_node_rm/meta'
+require 'chef_ec2_node_rm/sqs_message'
+require 'chef_ec2_node_rm/sqs_pollers'

data/lib/chef_ec2_node_rm/error.rb

@@ -0,0 +1,8 @@
+module ChefEc2NodeRm
+  class Error < StandardError; end
+
+  class SqsMessageError < Error; end
+  class SqsMessageMalformedJson < SqsMessageError; end
+  class SqsMessageNotHash < SqsMessageError; end
+  class SqsMessageMissingAttribute < SqsMessageError; end
+end

data/lib/chef_ec2_node_rm/knife.rb

@@ -0,0 +1,21 @@
+module ChefEc2NodeRm
+  class Knife
+    include Logging
+
+    def initialize(command)
+      @command = "knife #{command} --format json"
+    end
+
+    def run
+      logger.debug("Knife command: #{@command}")
+      result = `#{@command}`
+      result_parsed = begin
+        JSON.parse(result)
+      rescue JSON::ParserError
+        result
+      end
+      logger.debug("Knife output: #{result_parsed}")
+      result_parsed
+    end
+  end
+end

data/lib/chef_ec2_node_rm/logging.rb

@@ -0,0 +1,19 @@
+module ChefEc2NodeRm
+  module Logging
+    def logger
+      Logging.logger
+    end
+
+    def self.logger
+      @logger ||= Logger.new(@device || STDOUT)
+    end
+
+    def logger_device(device)
+      Logging.logger_device(device)
+    end
+
+    def self.logger_device(device)
+      @device = device
+    end
+  end
+end

data/lib/chef_ec2_node_rm/meta.rb

@@ -0,0 +1,8 @@
+module ChefEc2NodeRm
+  NAME = 'chef_ec2_node_rm'.freeze
+  VERSION = '0.1.0'.freeze
+  AUTHORS = [
+    'Mike Conigliaro <mike@conigliaro.org>'
+  ].freeze
+  URL = 'https://github.com/mconigliaro/chef_ec2_node_rm'.freeze
+end

data/lib/chef_ec2_node_rm/sqs_message.rb

@@ -0,0 +1,22 @@
+module ChefEc2NodeRm
+  class SqsMessage
+    attr_reader :instance_id, :state
+
+    def initialize(msg)
+      msg_parsed = JSON.parse(msg)
+      raise SqsMessageNotHash, "Expected a Hash but got a #{msg_parsed.class}" unless msg_parsed.is_a?(Hash)
+
+      attr_map = {
+        instance_id: ['detail', 'instance-id'],
+        state: %w[detail state]
+      }
+      attr_map.each do |name, path|
+        value = msg_parsed.dig(*path)
+        raise ChefEc2NodeRm::SqsMessageMissingAttribute, "Missing value for #{name} (msg='#{msg}', path='#{path.join('.')}')" if value.nil?
+        instance_variable_set("@#{name}", value)
+      end
+    rescue JSON::ParserError => e
+      raise ChefEc2NodeRm::SqsMessageMalformedJson, "Malformed JSON: #{e}"
+    end
+  end
+end

data/lib/chef_ec2_node_rm/sqs_pollers.rb

@@ -0,0 +1,38 @@
+module ChefEc2NodeRm
+  class SqsPollers
+    include Logging
+
+    attr_reader :pollers
+
+    def initialize(urls)
+      @pollers = urls.map do |url|
+        begin
+          logger.debug(url) { 'Verifying queue' }
+          # Each queue is verified by making a request for its attributes. An
+          # exception should get raised for any queue that is non-existent or
+          # otherwise unavailable.
+          Aws::SQS::Queue.new(url).attributes
+          Aws::SQS::QueuePoller.new(url)
+        rescue Aws::Errors::ServiceError => e
+          logger.error(url) { e.message }
+          nil
+        end
+      end.compact
+    end
+
+    def start
+      trap('SIGINT') { Thread.new { exit } }
+      @pollers.map do |poller|
+        Thread.new do
+          Thread.current.name = poller.queue_url
+          logger.info(Thread.current.name) { 'Starting poller' }
+          poller.poll(skip_delete: true) do |msg|
+            logger.debug(Thread.current.name) { %(Message received: id='#{msg.message_id}' body='#{msg.body.delete("\n")}') }
+            yield(poller, msg)
+          end
+        end
+      end.each(&:join)
+      logger.info('No queues left to poll')
+    end
+  end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: chef_ec2_node_rm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Conigliaro <mike@conigliaro.org>
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-autotest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.45'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.45'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-sqs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Automatically delete chef node/client data on EC2
+email:
+- mike@conigliaro.org
+executables:
+- chef_ec2_node_rm
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".tool-versions"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- chef_ec2_node_rm.gemspec
+- exe/chef_ec2_node_rm
+- lib/chef_ec2_node_rm.rb
+- lib/chef_ec2_node_rm/error.rb
+- lib/chef_ec2_node_rm/knife.rb
+- lib/chef_ec2_node_rm/logging.rb
+- lib/chef_ec2_node_rm/meta.rb
+- lib/chef_ec2_node_rm/sqs_message.rb
+- lib/chef_ec2_node_rm/sqs_pollers.rb
+homepage: https://github.com/mconigliaro/chef_ec2_node_rm
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Automatically delete chef node/client data on EC2
+test_files: []