sortinghat 0.3.3 → 0.3.4.develop

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8781c38bf0c7c5db4a3ca524b653fc6dd43bf457
-  data.tar.gz: 70f1c58afeadd42a06e63d02b95f87cdb5237be7
+SHA256:
+  metadata.gz: 9a0bb1fc284e16b20cff54621a6608e51c1b233fcfe6877012c9f9f2560a0453
+  data.tar.gz: 4fb17c7cccf23ed6e006e90d171d0ef339a2516664907d1fb166d9c3b9e05d29
 SHA512:
-  metadata.gz: c9a2813b2ff10016d9dfbed256170a088104c1ae986c23d39e6ea0584fffdb59349d84ad01bec7be403aecdba4aa7c00215894a79cef5f377e2af89a83bb8d0d
-  data.tar.gz: 5715916fce1f304cc93b7140389ab1af2f12b6a005ad89ad7e5bc7aed9be456f5c590a1964040e4c1f64a35dae33fddbe37921ba444bcd718aa5ddb557fb7444
+  metadata.gz: '07584c6af915ac9aea638cd9e24592b4fa8576545285298ece0ec4bfd5deff9bee34ae9db876dffc63d610103e44edc1eefc26ba90313819802d5b66bd7284a3'
+  data.tar.gz: 83fed95b1925f27736a4f4fd9b20807a6bf2ddf2a0b0ca6beb61ccb244d1bc3c126bd4835f3a6339bc26c3ebf19afc4cc8bc33f4c3c4c415584da97fc113666c

data/.gitignore

@@ -1,4 +1,5 @@
 /.bundle/
+/.idea/
 /.yardoc
 /Gemfile.lock
 /_yardoc/
@@ -7,3 +8,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+/*.gem
+/*.sublime*

data/README.md

@@ -1,4 +1,8 @@
 # Sortinghat
+[![Gem Version](https://badge.fury.io/rb/sortinghat.svg)](https://badge.fury.io/rb/sortinghat)
+[![Total Gem Downloads](https://ruby-gem-downloads-badge.herokuapp.com/sortinghat?type=total)](https://rubygems.org/gems/sortinghat)
+[![Build Status](https://travis-ci.org/praymann/sortinghat.svg?branch=master)](https://travis-ci.org/praymann/sortinghat?branch=master)
+[![Build Status](https://travis-ci.org/praymann/sortinghat.svg?branch=develop)](https://travis-ci.org/praymann/sortinghat?branch=develop)
 
 Sortinghat is a unqiue Ruby gem that allows AWS AutoScaling instances to name themselves.
 
@@ -9,12 +13,12 @@ When the Sorting Hat is given specific arguments, it can find the gaps in curren
 It follows a specific pattern for hostnames/fqdn:
 
 ```
-[client]-[environment]-[type][prefix].[domain].com.
+[client]-[environment]-[type][suffix]-[region].[domain].com.
 ```
 For example:
 
 ```
-nike-prod-nginx09.prod-nike.com
+nike-prod-nginx09-us-west-2.prod-nike.com
 ```
 
 ## Installation:
@@ -31,8 +35,6 @@ It requires the following gems:
 * aws-sdk 2.1.2
 * pure_json
 
-The v2.1.2 dependency comes from the fact that as of this writting the latest codedeploy-agent (installed via .rpm) breaks if it does not have v2.1.2.
-
 During actually usage, the gem requires that the instance have the following IAM actions allowed via policy:
 * autoscaling:DescribeAutoScalingInstances
 * autoscaling:DescribeAutoScalingGroups
@@ -71,6 +73,11 @@ Run:
 
     $ bundle exec bin/sortinghat -h
 
+## Credits
+
+Kudos to [nerk01](https://github.com/nerk01) for help and guidance with anything Ruby! He is also a contributor to this project.
+ 
+Kudos to [jrbeilke](https://github.com/jrbeilke) for help and guidance with Ruby and the "[rubber duck debugging](https://en.wikipedia.org/wiki/Rubber_duck_debugging)" support.
 
 ## Contributing
 

data/bin/sortinghat

@@ -5,13 +5,17 @@ require 'optparse'
 
 options = {}
 
+# Default to being numbered instances
+options[:numbered] = true
+
 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.banner = 'Usage: sortinghat [OPTIONS]'
+  opt.separator ''
+  opt.separator 'All options except --numbered are required for the Sorting Hat to function.'
+  opt.separator 'The option --numbered is by default \'true\''
+  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
@@ -26,13 +30,17 @@ parser = OptionParser.new do |opt|
   end
 
   opt.on("-r", "--region REGION", "Region name") do |region|
-    options[:region] = region 
+    options[:region] = region
   end
 
   opt.on("-z", "--zone DOMAIN", "Hosted Zone") do |zone|
     options[:zone] = zone
   end
 
+  opt.on('-n', '--[not-]numbered', 'Number suffix?') do |numbered|
+    options[:numbered] = numbered
+  end
+
   opt.on("-h", "--help", "Help menu") do
     puts parser
     exit 0
@@ -41,12 +49,6 @@ end
 
 parser.parse!
 
-if options.length < 5 
-  abort "All options are required."
-end
-
-this = Sortinghat::Banquet.new(options)
-
-this.dejavu?
+abort 'All options are required.' if options.length < 5
 
-this.start!
+Sortinghat::Banquet.assign_house(options)

data/lib/sortinghat/aws.rb

@@ -5,12 +5,13 @@ require 'date'
 
 module Sortinghat
   class AWS
-    def initialize( region = 'us-east-1' )
+    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)
+      @ec2_client = Aws::EC2::Client.new(region: @region)
+      @autoscale_client = Aws::AutoScaling::Client.new(region: @region)
 
       # Create a syslog for us to use as an instance variable
       @log = Syslog::Logger.new 'sortinghat'
@@ -18,35 +19,28 @@ module Sortinghat
 
     # Method to discover what auto-scaling group the current instance is in, then the instances in that group
     # 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 describe this instance
-      current = autoscale.describe_auto_scaling_instances({
-        instance_ids: [grabinstanceid()],
-        max_records: 1
-      })
-      @log.info("Grabbed current AutoScaling instance via aws-sdk")
-
+    def discover
       # Use the client to grab all instances in this auto-scaling group
-      all = autoscale.describe_auto_scaling_groups({
-        auto_scaling_group_names: [current.auto_scaling_instances[0].auto_scaling_group_name],
+      all = @autoscale_client.describe_auto_scaling_groups(
+        auto_scaling_group_names: [find_own_autoscale_name],
         max_records: 1
-      })
-      @log.info("Grabbed the instances of our AutoScaling group via aws-sdk")
+      )
+      @log.info('Grabbed the instances of our AutoScaling group via aws-sdk')
+
+      # Grab their hostname(s)
+      names = all.auto_scaling_groups[0].instances.map { |instance| idtoname(instance.instance_id) }
+      @log.info("Returning instances '#{names.join("','")}'")
 
-      # Grab their instanceId(s)
-      all.auto_scaling_groups[0].instances.each do |instance|
-        ids << idtoname(instance.instance_id)
-      end
-      @log.info("Returning instances '#{ids.join("','")}'")      
-      
       # Return the ids
-      ids
+      names
+    end
+
+    # Method to search for instances matching a hostname
+    # Returns array of instances
+    def search_hosts(hostname)
+      resp = @client.describe_instances(filters: [{ name: 'tag:Name', value: [hostname] }])
+      return resp.reservations unless resp.reservations.empty?
+      []
     end
 
     # Method to set the Name tag on the current instance
@@ -56,32 +50,21 @@ module Sortinghat
       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,
-          },
-	      ]
-      })
+      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!()
+    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)}",
-          },
-        ]
-      })
+      hostname = "sortinghat-#{rand(100)}"
+      resource.instance(grabinstanceid)
+              .create_tags(tags: [{ key: 'Name', value: hostname }])
       @log.info("Set Name tag to temporary #{hostname} via aws-sdk")
     end
 
@@ -89,10 +72,10 @@ module Sortinghat
     # 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({
+      Aws::Route53::Client.new(region: @region).change_resource_record_sets(
         hosted_zone_id: zonetoid(zone),
         change_batch: {
-          comment: "Sorting Hat #{Date.today.to_s}",
+          comment: "Sorting Hat #{Date.today}",
           changes: [
             {
               action: 'UPSERT',
@@ -100,22 +83,18 @@ module Sortinghat
                 name: fqdn,
                 type: 'A',
                 ttl: '30',
-                resource_records: [
-                  {
-                    value: grabinstanceprivateip()
-                  },
-                ],
-              },
-            },
-          ],
-        },
-      })  
+                resource_records: [{ value: grabinstanceprivateip }]
+              }
+            }
+          ]
+        }
+      )
       @log.info("Issued UPSERT to Route53 for #{fqdn}")
     end
 
-    def privateip()
-      return grabinstanceprivateip()
-    end 
+    def privateip
+      grabinstanceprivateip
+    end
 
     private
 
@@ -126,20 +105,30 @@ module Sortinghat
     end
 
     def zonetoid(hostedzone)
-      resp = Aws::Route53::Client.new(region: @region).list_hosted_zones()
+      resp = Aws::Route53::Client.new(region: @region).list_hosted_zones
       resp.hosted_zones.each do |zone|
-        if zone.name == hostedzone
-          return zone.id
-        end
+        return zone.id if zone.name == hostedzone
       end
     end
 
-    def grabinstanceid()
-      return Net::HTTP.get_response(URI.parse("http://169.254.169.254/latest/meta-data/instance-id")).body
+    def grabinstanceid
+      Net::HTTP.get_response(URI.parse('http://169.254.169.254/latest/meta-data/instance-id')).body
+    end
+
+    def grabinstanceprivateip
+      Net::HTTP.get_response(URI.parse('http://169.254.169.254/latest/meta-data/local-ipv4')).body
     end
 
-    def grabinstanceprivateip()
-      return Net::HTTP.get_response(URI.parse("http://169.254.169.254/latest/meta-data/local-ipv4")).body
+    def find_own_autoscale_name
+      # Use the client to describe this instances autoscale
+      current_as = @autoscale_client.describe_auto_scaling_instances(
+        instance_ids: [grabinstanceid],
+        max_records: 1
+      )
+      @log.info('Grabbed current AutoScaling instance via aws-sdk')
+
+      # Return current autoscale name
+      current_as.auto_scaling_instances[0].auto_scaling_group_name
     end
   end
 end

data/lib/sortinghat/banquet.rb

@@ -3,19 +3,22 @@ require 'fileutils'
 
 module Sortinghat
   class Banquet
+    def self.assign_house(options = {})
+      this = new(options)
+      this.dejavu?
+      this.start!
+    end
 
     # Creation method
     def initialize(options = {})
       # Check that we have write premissions
-      checkpermissions()
+      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
+      options[:zone] << '.' if options[:zone][-1, 1] != '.'
 
       # Save the options as instance variable
       @options = options
@@ -27,7 +30,7 @@ module Sortinghat
     # Method to figure out if we've been here before
     def dejavu?
       # Check for sentinel file
-      if File.exists?('/etc/.sorted')
+      if File.exist?('/etc/.sorted')
         # We found it, log error and exit successfully
         @log.info('Found /etc/.sorted, refusing to sort.')
         exit 0
@@ -36,51 +39,25 @@ module Sortinghat
 
     # Main method of Sortinghat
     def start!
-
-      # Best thing to avoid run conditions are to wait
-      sleep rand(10)
-
-      # Find out who is who, instances alive
-      # If discover() returns an Array full of nil(s), alive will become an empty Array
-      alive = cleanup(@aws.discover())
-
-      # Given the alive instances, find our prefix
-      # If alive an empty array, selection will return the number '1'
-      @prefix = ensurezero(selection(alive))
-
-      # Put together hostname/fqdn
-      construction()
+      construct_hostname
 
       # Set the Name tag on this instance
       @aws.settag!(@hostname)
 
-      # Find out who is who, instances alive
-      # If discover() returns an Array full of nil(s), alive will become an empty Array
-      alive = cleanup(@aws.discover())
-
-      # Only enter recursion if the uniq() length of the alive array does not equal the actual length
-      # On AutoScalingGroup initalization, the cleanup() should ensure the alive array is empty not nil so uniq() works
-      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()
+      setlocal
 
       # Set /etc/hosts
-      sethostsfile()
+      sethostsfile
 
       # Throw the hostname in /etc/sysconfig/httpd (if exists)
-      givetohttpd()
+      givetohttpd
 
       # All done
-      finish!()
+      finish!
     end
 
     # Last method of Sortinghat
@@ -92,7 +69,7 @@ module Sortinghat
     private
 
     # Method to check that we have write permissions to /etc/*
-    def checkpermissions()
+    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.')
@@ -103,71 +80,87 @@ module Sortinghat
     # Method to cleanup the array returned by aws.discover()
     # Remove nil values basically
     def cleanup(array)
-      clean = array.reject { |item| item.nil? }
+      clean = array.reject(&:nil?)
       return [] if clean.empty?
       clean
     end
 
-    # Method to consume the alive array and figure out what this instance's prefix should be
+    # Cconsume the alive array and return array of available suffix
     def selection(array)
-      # If array is empty, just return 01
-      return 1 if array.empty?
+      array = cleanup(array)
 
-      # Array to store the numbers already taken
-      taken = Array.new
+      # If array is empty, just return 01
+      return [1] if array.empty?
 
       # 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 }
+      taken = array.map { |str| str[/^.*\D(\d{2,}).*/, 1].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]
+      # Return the avilable values once we find what isn't taken in our range of numbers
+      limits - taken
+    end
+
+    def construct_hostname
+      # Get array of hostnames in our scale group
+      scalegroup_hosts = @aws.discover
+
+      # determine the next available suffix
+      selection(scalegroup_hosts).find(method(:assignment_unclear)) do |candidate|
+        @suffix = ''
+        @suffix = ensurezero(candidate) if @options[:numbered]
+        construction
+        matches = @aws.search_hosts(@hostname)
+        matches.empty?
+      end
     end
 
-    # Method to ensure our prefix always has a leading 0 if < 10
-    def ensurezero(prefix)
-      prefix < 10 ? prefix.to_s.rjust(2, "0") : prefix
+    # Method to ensure our suffix always has a leading 0 if < 10
+    def ensurezero(suffix)
+      return suffix.to_s.rjust(2, '0') if suffix < 10
+      suffix
     end
 
     # Method to construct our instance variables @hostname and @fqdn
-    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]}"
+    def construction
+      @hostname = "#{@options[:client]}-#{@options[:env]}-#{@options[:type]}#{@suffix}-#{@options[:region]}"
+      @fqdn = "#{@options[:client]}-#{@options[:env]}-#{@options[:type]}#{@suffix}-#{@options[:region]}.#{@options[:zone]}"
+    end
+
+    def assignment_unclear
+      @suffix = ensurezero("#{rand(100)}")
+      construction
     end
 
     # Method to set the local hostname on this instance
-    def setlocal()
+    def setlocal
       if system("hostnamectl set-hostname #{@fqdn}")
         @log.info("Set the localhost hostname to #{@fqdn}.")
       end
     end
 
-    def sethostsfile()
+    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
+      if File.readlines('/etc/hosts').grep(/#{@hostname}|#{privateip}/).empty?
         File.open('/etc/hosts', 'a') do |file|
           file.puts "#{privateip} \t #{@hostname} #{@fqdn}"
         end
-        @log.info("Added hostname(s) to /etc/hosts.")
+        @log.info('Added hostname(s) to /etc/hosts.')
       else
-        @log.warn("The hostname(s) were already in /etc/hosts.")
+        @log.warn('The hostname(s) were already in /etc/hosts.')
       end
     end
 
-    def givetohttpd()
+    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
+      return unless File.exist?(file)
+      if File.readlines(file).grep(/HOSTNAME/).empty?
+        @log.info("Found #{file}, appending HOSTNAME=#{@hostname}.")
+        File.open(file, 'a') { |sysconfig| sysconfig.puts "HOSTNAME=#{@hostname}" }
+      else
+        @log.warn("Found HOSTNAME already in #{file}")
       end
     end
   end

data/lib/sortinghat/version.rb

@@ -1,3 +1,3 @@
 module Sortinghat
-  VERSION = "0.3.3"
+  VERSION = '0.3.4.develop'.freeze
 end

data/sortinghat.gemspec

@@ -31,6 +31,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
 
-  spec.add_runtime_dependency "aws-sdk", '2.1.2'
+  spec.add_runtime_dependency "aws-sdk", "~> 2.1.2"
   spec.add_runtime_dependency "json_pure"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sortinghat
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4.develop
 platform: ruby
 authors:
 - D. Pramann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-21 00:00:00.000000000 Z
+date: 2019-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,14 +56,14 @@ dependencies:
   name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.1.2
 - !ruby/object:Gem::Dependency
@@ -118,12 +118,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.4.8
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Have auto-scaling instances name themselves!