ec2launcher 1.2.0 → 1.3.0

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 1.3.0
+
+* Backward imcompatible change: terminating an instance now requires environment name.
+* Added support for automatically adding A records in Route53 for new instances.
+* Added support for automatically deleting A records from Route53 when terminating an instance.
+* Added new "route53_zone_id" config option to environments to support Route53 integration.
+
 ## 1.2.0
 
 * Added support for terminating instances.

data/lib/ec2launcher.rb

@@ -19,6 +19,7 @@ require 'ec2launcher/backoff_runner'
 require 'ec2launcher/instance_paths_config'
 require 'ec2launcher/block_device_builder'
 require 'ec2launcher/hostname_generator'
+require 'ec2launcher/route53'
 
 require 'ec2launcher/config_wrapper'
 
@@ -106,6 +107,20 @@ module EC2Launcher
       initialize_aws(@options.access_key, @options.secret)
       @ec2 = AWS::EC2.new
 
+      ##############################
+      # Create Route53 connection
+      ##############################
+      @route53 = nil
+      @route53_zone_id = nil
+      @route53_domain_name = nil
+      if @environment.route53_zone_id
+        aws_route53 = AWS::Route53.new 
+        @route53 = EC2Launcher::Route53.new(aws_route53, @environment.route53_zone_id)
+        @route53_zone_id = @environment.route53_zone_id
+        route53_zone = aws_route53.client.get_hosted_zone({:id => @environment.route53_zone_id})
+        @route53_domain_name = route53_zone[:hosted_zone][:name].chop
+      end
+
       ##############################
       # SUBNET
       ##############################
@@ -203,6 +218,14 @@ module EC2Launcher
       ami_name_match ||= @environment.ami_name
       ami = find_ami(instance_architecture, instance_virtualization, ami_name_match, @options.ami_id)
 
+      ##############################
+      # DOMAIN NAME
+      ##############################
+
+      # Note: Route53 domain names override domain names specified in the environments
+      @domain_name = @route53_domain_name
+      @domain_name ||= @environment.domain_name
+
       ##############################
       # HOSTNAME
       ##############################
@@ -212,14 +235,14 @@ module EC2Launcher
       if @options.count > 1
         1.upto(@options.count).each do |i|
           short_hostname = hostname_generator.generate_hostname()
-          long_hostname = hostname_generator.generate_long_name(short_hostname, @environment.domain_name)
+          long_hostname = hostname_generator.generate_long_name(short_hostname, @domain_name)
           short_hostnames << short_hostname
           fqdn_names << long_hostname
         end
       else
         if @options.hostname.nil?
           short_hostname = hostname_generator.generate_hostname()
-          long_hostname = hostname_generator.generate_long_name(short_hostname, @environment.domain_name)
+          long_hostname = hostname_generator.generate_long_name(short_hostname, @domain_name)
         else
           long_hostname = @options.hostname
           short_hostname = hostname_generator.generate_short_name(long_hostname, @environment.domain_name)
@@ -285,7 +308,7 @@ module EC2Launcher
 
       ##############################
       @log.info
-      @log.info "Availability zone: #{availability_zone}"
+      @log.info "Availability zone   : #{availability_zone}"
       @log.info "Key name            : #{key_name}"
       @log.info "Security groups     : " + security_groups.collect {|name| "#{name} (#{sg_map[name].security_group_id})"}.join(", ")
       @log.info "IAM profile         : #{iam_profile}" if iam_profile
@@ -294,6 +317,7 @@ module EC2Launcher
       @log.info "AMI name            : #{ami.ami_name}"
       @log.info "AMI id              : #{ami.ami_id}"
       @log.info "ELB                 : #{elb_name}" if elb_name
+      @log.info "Route53 Zone        : #{@route53_domain_name}" if @route53_domain_name
       @log.info "Chef PEM            : #{chef_validation_pem_url}"
       @log.info "AWS key file        : #{aws_keyfile}"
       @log.info "Roles               : #{roles.join(', ')}"
@@ -348,7 +372,7 @@ module EC2Launcher
         block_device_tags = block_device_builder.generate_device_tags(fqdn_names[i], short_hostnames[i], @environment.name, @application.block_devices)
         user_data = build_launch_command(fqdn_names[i], short_hostnames[i], roles, chef_validation_pem_url, aws_keyfile, gems, packages, email_notifications)
 
-        instance = launch_instance(fqdn_names[i], ami.ami_id, availability_zone, key_name, security_group_ids, iam_profile, instance_type, user_data, block_device_mappings, block_device_tags, subnet)
+        instance = launch_instance(fqdn_names[i], short_hostnames[i], ami.ami_id, availability_zone, key_name, security_group_ids, iam_profile, instance_type, user_data, block_device_mappings, block_device_tags, subnet)
         instances << instance
 
         public_dns_name = get_instance_dns(instance, true)
@@ -501,7 +525,7 @@ module EC2Launcher
     # @param [Hash<String,Hash<String, String>>, nil] block_device_tags mapping of device names to hash objects with tags for the new EBS block devices.
     #
     # @return [AWS::EC2::Instance] newly created EC2 instance or nil if the launch failed.
-    def launch_instance(hostname, ami_id, availability_zone, key_name, security_group_ids, iam_profile, instance_type, user_data, block_device_mappings = nil, block_device_tags = nil, vpc_subnet = nil)
+    def launch_instance(hostname, short_hostname, ami_id, availability_zone, key_name, security_group_ids, iam_profile, instance_type, user_data, block_device_mappings = nil, block_device_tags = nil, vpc_subnet = nil)
       @log.warn "Launching instance... #{hostname}"
       new_instance = nil
       run_with_backoff(30, 1, "launching instance") do
@@ -544,6 +568,7 @@ module EC2Launcher
       # Tag instance
       @log.info "Tagging instance..."
       run_with_backoff(30, 1, "tag #{new_instance.id}, tag: name, value: #{hostname}") { new_instance.add_tag("Name", :value => hostname) }
+      run_with_backoff(30, 1, "tag #{new_instance.id}, tag: short_name, value: #{short_hostname}") { new_instance.add_tag("short_name", :value => short_hostname) }
       run_with_backoff(30, 1, "tag #{new_instance.id}, tag: environment, value: #{@environment.name}") { new_instance.add_tag("environment", :value => @environment.name) }
       run_with_backoff(30, 1, "tag #{new_instance.id}, tag: application, value: #{@application.name}") { new_instance.add_tag("application", :value => @application.name) }
 
@@ -563,6 +588,13 @@ module EC2Launcher
         AWS.stop_memoizing
       end
 
+      ##############################
+      # Add to Route53
+      if @route53
+        @log.info "Adding A record to Route53: #{hostname} => #{new_instance.private_ip_address}"
+        @route53.create_record(hostname, new_instance.private_ip_address, 'A')
+      end
+
       new_instance
     end
 

data/lib/ec2launcher/backoff_runner.rb

@@ -20,7 +20,7 @@ module EC2Launcher
       end
       
       begin
-        yield
+        block.call
       rescue AWS::EC2::Errors::RequestLimitExceeded
         puts "AWS::EC2::Errors::RequestLimitExceeded ... retrying #{message} in #{sleep_time} seconds"
         sleep sleep_time

data/lib/ec2launcher/dsl/application.rb

@@ -144,9 +144,9 @@ module EC2Launcher
 			# Takes values from the other server type and merges them into this one
 			def merge(other_server)
 				@name = other_server.name
-				@ami_name = other_server.ami_name unless other_server.ami_name.nil?
-				@availability_zone = other_server.availability_zone unless other_server.availability_zone.nil?
-				@basename = other_server.basename unless other_server.basename.nil?
+				@ami_name = other_server.ami_name if other_server.ami_name
+				@availability_zone = other_server.availability_zone if other_server.availability_zone
+				@basename = other_server.basename if other_server.basename
 				
 				unless other_server.block_devices.nil?
 					@block_devices = [] if @block_devices.nil?
@@ -158,9 +158,9 @@ module EC2Launcher
 					other_server.elb.keys.each {|env_name| @elb[env_name] = other_server.elb[env_name] } 
 				end
 				
-				@iam_profile = other_server.iam_profile unless other_server.iam_profile.nil?
-				@instance_type = other_server.instance_type unless other_server.instance_type.nil?
-				@name_suffix = other_server.name_suffix unless other_server.name_suffix.nil?
+				@iam_profile = other_server.iam_profile if other_server.iam_profile
+				@instance_type = other_server.instance_type if other_server.instance_type
+				@name_suffix = other_server.name_suffix if other_server.name_suffix
 				
 				unless other_server.roles.nil?
 					@roles = [] if @roles.nil?
@@ -177,14 +177,14 @@ module EC2Launcher
 					end
 				end
 
-				@use_rvm = other_server.use_rvm unless other_server.use_rvm.nil?
+				@use_rvm = other_server.use_rvm if other_server.use_rvm
 			end
 
 			def roles_for_environment(environment)
 				roles = []
 				roles += @roles unless @roles.nil?
 
-				unless @environment_roles.nil? || @environment_roles[environment].nil?
+				if @environment_roles && @environment_roles[environment]
 					roles += @environment_roles[environment]
 				end
 				roles

data/lib/ec2launcher/dsl/environment.rb

@@ -33,6 +33,9 @@ module EC2Launcher
 			dsl_accessor :subnet
 			dsl_accessor :use_rvm
 
+			# @since 1.3.0
+			dsl_accessor :route53_zone_id
+
 			dsl_array_accessor :aliases
 			dsl_array_accessor :gems
 			dsl_array_accessor :packages
@@ -54,6 +57,7 @@ module EC2Launcher
 				@precommand = []
 				@postcommand = []
 				@roles = []
+				@route53_zone_id = nil
 				@security_groups = {}
 
 				@use_rvm = true
@@ -69,12 +73,12 @@ module EC2Launcher
 			def merge(other_env)
 				@name =other_env.name
 
-				@gems += other_env.gems unless other_env.gems.nil?
-				@packages += other_env.packages unless other_env.packages.nil?
-				@roles += other_env.roles unless other_env.roles.nil?
-				@precommand += other_env.precommand unless other_env.precommand.nil?
-				@postcommand += other_env.postcommand unless other_env.postcommand.nil?
-				unless other_env.security_groups.nil?
+				@gems += other_env.gems if other_env.gems
+				@packages += other_env.packages if other_env.packages
+				@roles += other_env.roles if other_env.roles
+				@precommand += other_env.precommand if other_env.precommand
+				@postcommand += other_env.postcommand if other_env.postcommand
+				if other_env.security_groups
 					other_env.security_groups.keys.each do |key|
 						@security_groups[key] = [] if @security_groups[key].nil?
 						@security_groups[key] += other_env.security_groups[key]
@@ -83,22 +87,23 @@ module EC2Launcher
 
 				@aliases = other_env.aliases.nil? ? nil : other_env.aliases
 
-				@ami_name = other_env.ami_name unless other_env.ami_name.nil?
-				@aws_keyfile = other_env.aws_keyfile unless other_env.aws_keyfile.nil?
-				@availability_zone = other_env.availability_zone unless other_env.availability_zone.nil?
-				@chef_path = other_env.chef_path unless other_env.chef_path.nil?
-				@chef_server_url = other_env.chef_server_url unless other_env.chef_server_url.nil?
-				@chef_validation_pem_url = other_env.chef_validation_pem_url unless other_env.chef_validation_pem_url.nil?
-				@domain_name = other_env.domain_name unless other_env.domain_name.nil?
-				@email_notifications = other_env.email_notifications unless other_env.email_notifications.nil?
-				@gem_path = other_env.gem_path unless other_env.gem_path.nil?
-				@iam_profile = other_env.iam_profile unless other_env.iam_profile.nil?
-				@key_name = other_env.key_name unless other_env.key_name.nil?
-				@knife_path = other_env.knife_path unless other_env.knife_path.nil?
-				@ruby_path = other_env.ruby_path unless other_env.ruby_path.nil?
-				@subnet = other_env.subnet unless other_env.subnet.nil?
-				@short_name = other_env.short_name unless other_env.short_name.nil?
-				@use_rvm = other_env.use_rvm unless other_env.use_rvm.nil?
+				@ami_name = other_env.ami_name if other_env.ami_name
+				@aws_keyfile = other_env.aws_keyfile if other_env.aws_keyfile
+				@availability_zone = other_env.availability_zone if other_env.availability_zone
+				@chef_path = other_env.chef_path if other_env.chef_path
+				@chef_server_url = other_env.chef_server_url if other_env.chef_server_url
+				@chef_validation_pem_url = other_env.chef_validation_pem_url if other_env.chef_validation_pem_url
+				@domain_name = other_env.domain_name if other_env.domain_name
+				@email_notifications = other_env.email_notifications if other_env.email_notifications
+				@gem_path = other_env.gem_path if other_env.gem_path
+				@iam_profile = other_env.iam_profile if other_env.iam_profile
+				@key_name = other_env.key_name if other_env.key_name
+				@knife_path = other_env.knife_path if other_env.knife_path
+				@route53_zone_id = other_env.route53_zone_id if other_env.route53_zone_id
+				@ruby_path = other_env.ruby_path if other_env.ruby_path
+				@subnet = other_env.subnet if other_env.subnet
+				@short_name = other_env.short_name if other_env.short_name
+				@use_rvm = other_env.use_rvm if other_env.use_rvm
 		end
 
 			def load(dsl)

data/lib/ec2launcher/init_options.rb

@@ -175,6 +175,15 @@ module EC2Launcher
         end
         @location = args[0]
       elsif @command =~ /^term/
+        @opts.parse!(args)
+
+        if @options.environ.nil?
+          puts "Missing a required parameter: --environment"
+          puts
+          help
+          exit 1
+        end
+
         unless args.length >= 1
           puts "Missing name of server!"
           puts

data/lib/ec2launcher/route53.rb

@@ -0,0 +1,110 @@
+#
+# Copyright (c) 2012 Sean Laurent
+#
+require 'rubygems'
+require 'aws-sdk'
+require 'log4r'
+
+module EC2Launcher
+  class Route53
+    #
+    # @param [AWS::Route53] route53 Initialized Route53 object
+    # @param [String] hosted_zone_id Zone ID
+    def initialize(route53, hosted_zone_id)
+      @log = Logger.new 'route53'
+      log_output = Outputter.stdout
+      log_output.formatter = PatternFormatter.new :pattern => "%m"
+      @log.outputters = log_output
+
+      @route53 = route53
+      @hosted_zone_id = hosted_zone_id
+    end
+
+    # Creates a new DNS record in Route53. Deletes any existing record with the
+    # same name and record type.
+    #
+    # @param [String] name  Name of the record
+    # @param [String] value Value for the DNS record
+    # @param [String] type  Type of DNS record: A, CNAME, etc. Defaults to 'A'.
+    # @param [Integer] ttl  TTL in seconds. Defaults to 300.
+    def create_record(name, value, type = "A", ttl = 300)
+      # Delete existing record because you can't update records
+      delete_record_by_name(name, type)
+
+      # Create new record
+      begin
+        @route53.client.change_resource_record_sets({
+          :hosted_zone_id => @hosted_zone_id, 
+          :change_batch => {
+            :changes => [ 
+              {
+                :action => "CREATE", 
+                :resource_record_set => { 
+                  :name => name, 
+                  :type => type,
+                  :ttl => ttl, 
+                  :resource_records => [ { :value => value } ]
+                }
+              }
+            ]
+          }
+        })
+      rescue StandardError => bang
+        @log.error "Error creating A record from Route53: #{bang}"
+      end
+    end
+
+    # Deletes a record by hostname, if it exists.
+    #
+    # @param [String] hostname Name of the record
+    # @param [String] record_type Type of DNS record: A, CNAME, etc.
+    # @param [Boolean] log_errors Log errors or not. False quietly ignores errors.
+    #
+    def delete_record_by_name(hostname, record_type = "A", log_errors = true)
+      # Find the record
+      response = @route53.client.list_resource_record_sets({
+        :hosted_zone_id => @hosted_zone_id,
+        :start_record_name => hostname,
+        :start_record_type => record_type,
+        :max_items => 1
+      })
+      if response && response.data
+        if response.data[:resource_record_sets] && response.data[:resource_record_sets].size > 0
+          record = response.data[:resource_record_sets][0]
+          delete_record(record[:name], record[:type], record[:ttl], record[:resource_records][0][:value], log_errors)
+        end
+      end
+    end
+
+    # Deletes a DNS record from Route53.
+    #
+    # @param [String] name  Name of the record
+    # @param [String] type  Type of DNS record: A, CNAME, etc.
+    # @param [Integer] ttl  TTL in seconds
+    # @param [String] value Value for the DNS record
+    # @param [Boolean] log_errors Log errors or not. False quietly ignores errors.
+    #
+    def delete_record(name, type, ttl, value, log_errors = true)
+      begin
+        @route53.client.change_resource_record_sets({
+          :hosted_zone_id => @hosted_zone_id, 
+          :change_batch => {
+            :changes => [ 
+              {
+                :action => "DELETE", 
+                :resource_record_set => { 
+                  :name => name, 
+                  :type => type,
+                  :ttl => ttl, 
+                  :resource_records => [ { :value => value } ]
+                }
+              }
+            ]
+          }
+        })
+      rescue StandardError => bang
+        @log.error "Error deleting A record from Route53: #{bang}" if log_errors
+      end
+    end
+  end
+end

data/lib/ec2launcher/terminator.rb

@@ -7,6 +7,7 @@ require 'log4r'
 
 require 'ec2launcher/aws_initializer'
 require 'ec2launcher/backoff_runner'
+require 'ec2launcher/route53'
 
 module EC2Launcher
   class Terminator
@@ -21,11 +22,38 @@ module EC2Launcher
     end
 
     def terminate(server_name, options)
+      ##############################
+      # Load configuration data
+      ##############################
+      config_wrapper = ConfigWrapper.new(options.directory)
+
+      @config = config_wrapper.config
+      @environments = config_wrapper.environments
+
+      ##############################
+      # ENVIRONMENT
+      ##############################
+      unless @environments.has_key? options.environ
+        @log.fatal "Environment not found: #{options.environ}"
+        exit 2
+      end
+      @environment = @environments[options.environ]
+      
       ##############################
       # Initialize AWS and create EC2 connection
       ##############################
       initialize_aws(options.access_key, options.secret)
       @ec2 = AWS::EC2.new
+      
+      ##############################
+      # Create Route53 connection
+      ##############################
+      aws_route53 = AWS::Route53.new if @environment.route53_zone_id
+      @route53 = EC2Launcher::Route53.new(aws_route53, @environment.route53_zone_id)
+
+      ##############################
+      # Find instance
+      ##############################
       instance = nil
       AWS.memoize do
         instances = @ec2.instances.filter("tag:Name", server_name)
@@ -40,11 +68,17 @@ module EC2Launcher
       if instance
         @log.info("Terminating instance: #{server_name} [#{instance.instance_id}]")
         instance.terminate
+
+        if @route53
+          @log.info("Deleting A record from Route53: #{server_name} => #{instance.private_ip_address}")
+          @route53.delete_record_by_name(server_name, 'A')
+        end
+
         @log.info("Deleting node/client from Chef: #{server_name}")
         node_result = `echo "Y" |knife node delete #{server_name}`
         client_result = `echo "Y" |knife client delete #{server_name}`
-        @log.debug("Deleted Chef node: #{result}")
-        @log.debug("Deleted Chef client: #{result}")
+        @log.debug("Deleted Chef node: #{node_result}")
+        @log.debug("Deleted Chef client: #{client_result}")
       else
         @log.error("Unable to find instance: #{server_name}")
       end

data/lib/ec2launcher/version.rb

@@ -2,5 +2,5 @@
 # Copyright (c) 2012 Sean Laurent
 #
 module EC2Launcher
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

data/yard_extensions/dsl_attribute_handler.rb

@@ -0,0 +1,14 @@
+#
+# Copyright (c) 2012 Sean Laurent
+#
+
+# Handles YARD documentation for the custom DSL methods
+class DSLAttributeHandler < YARD::Handlers::Ruby::AttributeHandler
+  handles_method_call(:dsl_accessor)
+  handles_method_call(:dsl_array_accessor)
+  namespace_only
+
+  def process
+    push_state(:scope => :class) { super }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ec2launcher
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-03 00:00:00.000000000 Z
+date: 2012-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -78,12 +78,14 @@ files:
 - lib/ec2launcher/hostname_generator.rb
 - lib/ec2launcher/init_options.rb
 - lib/ec2launcher/instance_paths_config.rb
+- lib/ec2launcher/route53.rb
 - lib/ec2launcher/security_group_handler.rb
 - lib/ec2launcher/terminator.rb
 - lib/ec2launcher/version.rb
 - startup-scripts/runurl
 - startup-scripts/setup.rb
 - startup-scripts/setup_instance.rb
+- yard_extensions/dsl_attribute_handler.rb
 homepage: https://github.com/StudyBlue/ec2launcher
 licenses: []
 post_install_message: