sortinghat 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bf767b88b4dc1e13e2c2ba670b706efc8ce09d33
+  data.tar.gz: 42cda4780b90f711e220d44f7f46baa96d93d402
+SHA512:
+  metadata.gz: cde94d2d42010301ed9131a059086021067279fdd046069468f3ee9b3ec622ecdf43619a1a69360e36323963d15a4d8ded25fbaf1c19437f502b93c66ce8058d
+  data.tar.gz: 2845e1f467a07980e370e465e16f38fffc385cc02dd6eddd966465e0ed359f497dd9d9f7f700c0d3efb4213eabb99e14b291fff5302d97f51bba17c200fc50d2

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 D. Pramann
+
+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,80 @@
+# Sortinghat
+
+Sortinghat is a unqiue Ruby gem that allows AWS AutoScaling instances to name themselves.
+
+We all understand that naming your cattle is bad, they shouldn't be pets.. but hostnames are handy and readable, and [insert reason].
+
+When the Sorting Hat is given specific arguments, it can find the gaps in current prefixes or +1 from the last current prefix and name the instance accordingly; along with updating Route53.
+
+It follows a specific pattern for hostnames/fqdn:
+
+```
+[client]-[environment]-[type][prefix].[domain].com.
+```
+For example:
+
+```
+nike-prod-nginx09.prod-internal.nike.com
+```
+
+## Installation:
+
+Install however you please to your AMI(s) with:
+
+    $ gem install sortinghat
+
+## Requirements:
+
+The gem itself was developed under Ruby 2.0.0 to work with CentOS 7.
+
+It requires the following gems:
+* aws-sdk ~> 2
+* pure_json
+
+During actually usage, the gem requires that the instance have the following IAM actions allowed via policy:
+* autoscaling:Describe*
+* ec2:DescribeInstances
+* ec2:CreateTags
+* route53:ListHostedZones
+* route53:ChangeResourceRecordSets
+
+## Usage:
+
+Note: The Sorting Hat requires root privileges to write to files under /etc/.
+
+Have cloud-init, cfn-init, or [x/y/z], issue the following command:
+
+    $ sortinghat -c [client] -e [environment] -t [type] -r [region] -z [domain]
+
+Note: [domain] should be in the format of [domain].com, just like the AWS Console reports for the HostedZone. No need to add the trailing dot, it will be added should you forget.
+
+The Sorting Hat will log to syslog for information.
+
+The Sorting Hat may be re-run, provided you remove the empty file located at '/etc/.sorted'.
+
+## Development
+
+Need to develop on an EC2 instance with metadata available or spoof it somehow.
+
+Clone:
+
+    $ git clone https://github.com/praymann/sortinghat
+
+Execute:
+
+    $ bundle install
+
+Run:
+
+    $ bundle exec bin/sortinghat -h
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/praymann/sortinghat.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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/sortinghat

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+
+require 'sortinghat'
+require 'optparse'
+
+options = {}
+
+parser = OptionParser.new do |opt|
+  opt.banner = "Usage: sortinghat [OPTIONS]"
+  opt.separator ""
+  opt.separator "All options are required for the Sorting Hat to function."
+  opt.separator "A trailing dot will be added to the zone should you forget it."
+  opt.separator ""
+  opt.separator "Options:"
+
+  opt.on("-c", "--client CLIENT", "Client name") do |client|
+    options[:client] = client
+  end
+
+  opt.on("-e", "--env ENVIRONMENT", "Environment name") do |environment|
+    options[:env] = environment
+  end
+
+  opt.on("-t", "--type TYPE", "Type name") do |type|
+    options[:type] = type
+  end
+
+  opt.on("-r", "--region REGION", "Region name") do |region|
+    options[:region] = region 
+  end
+
+  opt.on("-z", "--zone DOMAIN", "Hosted Zone") do |zone|
+    options[:zone] = zone
+  end
+
+  opt.on("-h", "--help", "Help menu") do
+    puts parser
+    exit 0
+  end
+end
+
+parser.parse!
+
+if options.length < 5 
+  abort "All options are required."
+end
+
+this = Sortinghat::Banquet.new(options)
+
+this.dejavu?
+
+this.start!

data/lib/sortinghat.rb

@@ -0,0 +1,5 @@
+require "sortinghat/version"
+
+require "sortinghat/banquet"
+
+require "sortinghat/aws"

data/lib/sortinghat/aws.rb

@@ -0,0 +1,137 @@
+require 'aws-sdk'
+require 'net/http'
+require 'uri'
+require 'date'
+
+module Sortinghat
+  class AWS
+    def initialize( region = 'us-east-1' )
+      # Be using this lots, make it an instance variable
+      @region = region
+
+      # Set a generic client for use
+      @client = Aws::EC2::Client.new(region: @region)
+
+      # Create a syslog for us to use as an instance variable
+      @log = Syslog::Logger.new 'sortinghat'
+    end
+
+    # Method to discover all the alive auto-scaling instances
+    # Returns array of the Name tag values of the instances
+    def discover()
+      # Temporay array for use
+      ids = Array.new
+      
+      # Start a new client
+      autoscale = Aws::AutoScaling::Client.new( region: @region )
+
+      # Use the client to grab all autoscaling instances
+      resp = autoscale.describe_auto_scaling_instances()
+      @log.info("Grabbed all AutoScaling instances via aws-sdk")
+
+      # Grab their instanceId(s)
+      resp.auto_scaling_instances.each do |instance|
+	ids << idtoname(instance.instance_id)
+      end
+      
+      # Return the ids
+      ids
+    end
+
+    # Method to set the Name tag on the current instance
+    # Returns nothing
+    def settag!(hostname)
+      # Use the instance varible client to create a new Resource
+      resource = Aws::EC2::Resource.new(client: @client)
+
+      # Use the resource, to find current instance, and set the Name tag
+      resource.instance(grabinstanceid()).create_tags({
+        tags: [
+          { 
+            key: 'Name',
+            value: hostname,
+          },
+	]
+      })
+      @log.info("Set Name tag to #{hostname} via aws-sdk")
+    end
+
+    # Method to remove the Name tag, and set a temporary one
+    # Returns nothing
+    def removetag!()
+      # Use the instance varible client to create a new Resource
+      resource = Aws::EC2::Resource.new(client: @client)
+
+      # Use the resource, to find current instance, and set the Name tag
+      resource.instance(grabinstanceid()).create_tags({
+        tags: [
+          {
+            key: 'Name',
+            value: "sortinghat-#{rand(100)}",
+          },
+        ]
+      })
+      @log.info("Set Name tag to temporary #{hostname} via aws-sdk")
+    end
+
+    # Method to set the A record in Route53
+    # Returns nothing
+    def setroute53(zone, fqdn)
+      # Create a new client, and use it to update/insert our A record
+      Aws::Route53::Client.new(region: @region).change_resource_record_sets({
+        hosted_zone_id: zonetoid(zone),
+        change_batch: {
+          comment: "Sorting Hat #{Date.today.to_s}",
+          changes: [
+            {
+              action: 'UPSERT',
+              resource_record_set: {
+                name: fqdn,
+                type: 'A',
+                ttl: '30',
+                resource_records: [
+                  {
+                    value: grabinstanceprivateip()
+                  },
+                ],
+              },
+            },
+          ],
+        },
+      })  
+      @log.info("Issued UPSERT to Route53 for #{fqdn}")
+    end
+
+    def privateip()
+      return grabinstanceprivateip()
+    end 
+
+    private
+
+    def idtoname(instance_id)
+      resource = Aws::EC2::Resource.new(client: @client)
+      resource.instance(instance_id).tags.each do |tag|
+        if tag.key == 'Name'
+          return tag.value
+        end
+      end
+    end
+
+    def zonetoid(hostedzone)
+      resp = Aws::Route53::Client.new(region: @region).list_hosted_zones()
+      resp.hosted_zones.each do |zone|
+        if zone.name == hostedzone
+          return zone.id
+        end
+      end
+    end
+
+    def grabinstanceid()
+      return Net::HTTP.get_response(URI.parse("http://169.254.169.254/latest/meta-data/instance-id")).body
+    end
+
+    def grabinstanceprivateip()
+      return Net::HTTP.get_response(URI.parse("http://169.254.169.254/latest/meta-data/local-ipv4")).body
+    end
+  end
+end

data/lib/sortinghat/banquet.rb

@@ -0,0 +1,154 @@
+require 'syslog/logger'
+require 'fileutils'
+
+module Sortinghat
+  class Banquet
+
+    # Creation method
+    def initialize(options = {})
+      # Check that we have write premissions
+      checkpermissions()
+
+      # Create a syslog for us to use as an instance variable
+      @log = Syslog::Logger.new 'sortinghat'
+
+      # Append a trailing dot to the zone, if there isn't one
+      if options[:zone][-1, 1] != '.'
+        options[:zone] << '.'
+      end
+
+      # Save the options as instance variable
+      @options = options
+
+      # Create an instance varible to contain our AWS calls
+      @aws = Sortinghat::AWS.new(@options[:region])
+    end
+
+    # Method to figure out if we've been here before
+    def dejavu?
+      # Check for sentinel file
+      if File.exists?('/etc/.sorted')
+        # We found it, log error and exit successfully
+        @log.error('Found /etc/.sorted, refusing to sort.')
+        abort('Found /etc/.sorted, refusing to sort.')
+      end
+    end
+
+    # Main method of Sortinghat
+    def start!
+      # Find out who is who, instances alive
+      alive = cleanup(@aws.discover())
+
+      # Given the alive instances, find our prefix
+      @prefix = ensurezero(selection(alive))
+
+      # Put together hostname/fqdn
+      construction()
+
+      @aws.settag!(@hostname)
+
+      # Find out who is who, instances alive
+      alive = cleanup(@aws.discover())
+
+      unless alive.uniq.length == alive.length
+        # There are duplicates, remove tag, wait, restart
+        @aws.removetag!()
+        sleep rand(10)
+        start!()
+      end 
+
+      # Register in DNS
+      @aws.setroute53(@options[:zone], @fqdn)
+
+      # Set the localhost hostname
+      setlocal()
+
+      # Set /etc/hosts
+      sethostsfile()
+
+      # Throw the hostname in /etc/sysconfig/httpd (if exists)
+      givetohttpd()
+
+      # All done
+      finish!()
+    end
+
+    # Last method of Sortinghat
+    def finish!
+      # Create our sentinel file
+      FileUtils.touch('/etc/.sorted')
+    end
+
+    private
+
+    def checkpermissions()
+      unless File.stat('/etc/hosts').writable?
+        # We found it, log error and exit successfully
+        @log.error('Can not write to /etc, missing required permissions.')
+        abort('Can not write to /etc, are you root?')
+      end
+    end
+
+    def cleanup(array)
+      array.select! { |name| name.include?(@options[:env]) and name.include?(@options[:client]) and name.include?(@options[:type]) }
+    end
+
+    def selection(array)
+      # Array to store the numbers already taken 
+      taken = Array.new
+      
+      # Filter the incoming array, find the numbers and store them in the taken Array
+      array.each { |string| taken << string.scan(/\d./).join('').sub(/^0+/, '').to_i }
+      
+      # We have two digits, define our range of numbers
+      limits = (1..99).to_a
+
+      # Return the first value once we find what isn't taken in our range of numbers 
+      (limits - taken)[0]
+    end
+
+    def ensurezero(prefix)
+      if prefix < 10
+        prefix.to_s.rjust(2, "0")
+      end
+    end
+
+    def construction()
+      @hostname = "#{@options[:client]}-#{@options[:env]}-#{@options[:type]}#{@prefix.to_s}-#{@options[:region]}"
+      @fqdn = "#{@options[:client]}-#{@options[:env]}-#{@options[:type]}#{@prefix.to_s}-#{@options[:region]}.#{@options[:zone]}"
+    end
+
+    def setlocal()
+      if system("hostnamectl set-hostname #{@fqdn}")
+        @log.info("Set the localhost hostname to #{@fqdn}.")
+      end
+    end
+
+    def sethostsfile()
+      # Store the ip address so we only make one metadata call here
+      privateip = @aws.privateip()
+      if File.readlines('/etc/hosts').grep(/#{@hostname}|#{privateip}/).size < 1 
+        File.open('/etc/hosts', 'a') do |file|
+          file.puts "#{@privateip} \t #{@hostname} #{@fqdn}"
+        end
+        @log.info("Added hostname(s) to /etc/hosts.")
+      else
+        @log.warn("The hostname(s) were already in /etc/hosts.")
+      end
+    end
+
+    def givetohttpd()
+      file = '/etc/sysconfig/httpd'
+      if File.exists?(file)
+        if File.readlines(file).grep(/HOSTNAME/).size < 1
+          @log.info("Found #{file}, appending HOSTNAME=#{@hostname}.")
+          File.open(file, 'a') do |file|
+            file.puts "HOSTNAME=#{@hostname}"
+          end
+        else
+          @log.warn("Found HOSTNAME already in #{file}")
+        end
+      end
+    end
+  end
+end

data/lib/sortinghat/version.rb

@@ -0,0 +1,3 @@
+module Sortinghat
+  VERSION = "0.1.0"
+end

data/sortinghat.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sortinghat/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sortinghat"
+  spec.version       = Sortinghat::VERSION
+  spec.authors       = ["D. Pramann"]
+  spec.email         = ["daniel@pramann.org"]
+
+  spec.summary       = %q{Have auto-scaling instances name themselves!}
+  spec.description   = %q{Ruby gem which when given arguements, allows an instance in an auto-scaling group to name/dns/tag itself.}
+  spec.homepage      = "https://github.com/praymann/sortinghat"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+
+  spec.add_runtime_dependency "aws-sdk", '~> 2'
+  spec.add_runtime_dependency "json_pure"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: sortinghat
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- D. Pramann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: json_pure
+  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'
+description: Ruby gem which when given arguements, allows an instance in an auto-scaling
+  group to name/dns/tag itself.
+email:
+- daniel@pramann.org
+executables:
+- sortinghat
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/sortinghat
+- lib/sortinghat.rb
+- lib/sortinghat/aws.rb
+- lib/sortinghat/banquet.rb
+- lib/sortinghat/version.rb
+- sortinghat.gemspec
+homepage: https://github.com/praymann/sortinghat
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Have auto-scaling instances name themselves!
+test_files: []