jackal-cfn 0.2.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82ce644625dd07609c7f577d4aac80ad289ce94b
-  data.tar.gz: 3052efa5fbc0b06279e2adb15a5e829cf36c41df
+  metadata.gz: 03f6aca28ee41f97d470ccee32e9892ad20dd1d2
+  data.tar.gz: c7f4e3707f4d45ce97102a3628ba7b6f38dd148b
 SHA512:
-  metadata.gz: bb1df43542af6ed17f680cbc28482fd4270f00b27a9487e20097f714131b61a009db69a94d1e65aa2c6bb096db5e32564919e30b9c247da9dec51f91c68a169c
-  data.tar.gz: 77b196a91a89cafb1c1ee1d1a7f2e7ca700d4d0ee813b87b5c4a195b66cf8a718e99cac5aa01d524f2f4d6124a2a683d576068e137962ac94730252a4c5f347c
+  metadata.gz: 47649359b1ee36126a661a02c21f461fa2ce4f25e2f50316d655edb141de87c353c67fd90be10ec6c39b7a601883d497f6a9b232053d35da315a5c6e95021145
+  data.tar.gz: a12b5725e7b6f97f04ff6b7cce3e475350a45c46e9406d278e2990a0fe72115634c893264692e022524aef6fee56e6c56647b7cd06c89a9345a97cec32a712e7

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# v0.2.4
+* Add AmiRegister callback
+* Update initial payload handling
+
 # v0.2.2
 * Fix credentials location in configuration
 * Fix namespacing when access fog constants

data/lib/jackal-cfn.rb

@@ -11,5 +11,6 @@ module Jackal
     # Provided custom resources
     autoload :HashExtractor, 'jackal-cfn/resource/hash_extractor'
     autoload :AmiManager, 'jackal-cfn/resource/ami_manager'
+    autoload :AmiRegister, 'jackal-cfn/resource/ami_register'
   end
 end

data/lib/jackal-cfn/resource.rb

@@ -129,7 +129,7 @@ module Jackal
       # @return [Smash]
       def unpack(message)
         payload = super
-        if(self.class == Jackal::Cfn::Resource)
+        if(self.is_a?(Jackal::Cfn::Resource))
           begin
             if(payload['Body'] && payload['Body']['Message'])
               payload = MultiJson.load(payload.get('Body', 'Message')).to_smash
@@ -137,14 +137,16 @@ module Jackal
               payload[:origin_type] = message[:message].get('Body', 'Type')
               payload[:origin_subject] = message[:message].get('Body', 'Subject')
               payload[:request_type] = snakecase(payload[:request_type])
+              payload
+            else
+              payload.to_smash.fetch('Attributes', 'Body', payload.to_smash.fetch('Body', payload.to_smash))
             end
-            payload
           rescue MultiJson::ParseError
             # Not our expected format so return empty payload
             Smash.new
           end
         else
-          payload.to_smash.fetch('Body', payload.to_smash)
+          payload.to_smash.fetch('Attributes', 'Body', payload.to_smash.fetch('Body', payload.to_smash))
         end
       end
 
@@ -158,7 +160,7 @@ module Jackal
           :cfn_resource => data_payload
         )
         if(config[:reprocess])
-          Carnivore::Supervisor.supervisor[destination(:input)].transmit(payload)
+          Carnivore::Supervisor.supervisor[destination(:input, payload)].transmit(payload)
           message.confirm!
         else
           completed(payload, message)

data/lib/jackal-cfn/resource/ami_register.rb

@@ -0,0 +1,216 @@
+require 'jackal-cfn'
+
+module Jackal
+  module Cfn
+    # Register an AMI from an EC2 resource
+    #
+    # Expected resource:
+    #   {
+    #     "Type": "Custom::AmiRegister",
+    #     "Properties": {
+    #       "Parameters": {
+    #         "Name": String,
+    #         "InstanceId": String,
+    #         "Description": String,
+    #         "NoReboot": Boolean,
+    #         "BlockDeviceMappings": Array,
+    #         "HaltInstance": Boolean,
+    #         "Region": String
+    #       }
+    #     }
+    #   }
+    #
+    # Response Hash:
+    #   {
+    #     "AmiId": String
+    #   }
+    #
+    # Required configuration:
+    #   {
+    #     "config": {
+    #       "ami": {
+    #         "credentials": {
+    #           "compute": {
+    #             FOG_CREDENTIALS
+    #           }
+    #         }
+    #       }
+    #     }
+    #   }
+    class AmiRegister < Jackal::Cfn::Resource
+
+      PHYSICAL_ID_JOINER = '__-__'
+
+      # Ensure fog library is loaded
+      def setup(*_)
+        require 'fog'
+      end
+
+      # Process message, send value back to CFN
+      #
+      # @param message [Carnivore::Message]
+      def execute(message)
+        failure_wrap(message) do |payload|
+          cfn_resource = rekey_hash(payload.get(:data, :cfn_resource))
+          properties = rekey_hash(cfn_resource[:resource_properties])
+          parameters = rekey_hash(properties[:parameters])
+          cfn_response = build_response(cfn_resource)
+          poll_for_available = false
+          case cfn_resource[:request_type].to_sym
+          when :create
+            generate_ami(cfn_response, parameters)
+            unless(cfn_response['Status'] == 'FAILED')
+              if(parameters[:halt_instance].to_s == 'true')
+                halt_ec2_instance(parameters)
+              end
+            end
+            poll_for_available = true
+          when :update
+            destroy_ami(cfn_response, cfn_resource, parameters)
+            unless(cfn_response['Status'] == 'FAILED')
+              generate_ami(cfn_response, parameters)
+              if(parameters[:halt_instance].to_s == 'true')
+                halt_ec2_instance(parameters)
+              end
+            end
+            poll_for_available = true
+          when :delete
+            destroy_ami(cfn_response, cfn_resource, parameters)
+          else
+            error "Unknown request type received: #{cfn_resource[:request_type].inspect}"
+            cfn_response['Status'] = 'FAILED'
+            cfn_response['Reason'] = 'Unknown request type received'
+          end
+          if(poll_for_available && cfn_response['Status'] != 'FAILED')
+            result = poll_ami_available(message, parameters[:region], cfn_response['Data']['AmiId'])
+            if(result != 'available')
+              cfn_response['Status'] = 'FAILED'
+              cfn_response['Reason'] = "Registered AMI resulted in FAILED state #{cfn_response['Data']['AmiId']}"
+            end
+          end
+          respond_to_stack(cfn_response, cfn_resource[:response_url])
+          job_completed(:jackal_cfn, payload, message)
+        end
+      end
+
+      # Poll the status of the AMI being generated and return the
+      # final state once no longer "pending"
+      #
+      # @param message [Carnivore::Message]
+      # @param region [String]
+      # @param ami_id [String]
+      # @return [String] state of image (available/failed)
+      def poll_ami_available(message, region, ami_id)
+        available = false
+        pause_interval = config.fetch(:ami_register_interval, 5).to_i
+        if(ami_id)
+          until(available)
+            debug "Pausing for AMI to become available: #{ami_id} (wait time: #{pause_interval})"
+            message.touch!
+            sleep(pause_interval)
+            result = compute_api(region).describe_images(
+              'ImageId' => [ami_id]
+            )
+            result = result.body['imagesSet'].first
+            if(result['imageState'] != 'pending')
+              available = result['imageState']
+            else
+              debug "AMI is still in pending state: #{ami_id}"
+            end
+          end
+          available
+        else
+          raise ArgumentError.new 'No AMI ID was provided to poll for available state!'
+        end
+      end
+
+      # Halt an EC2 instance
+      #
+      # @param instance_id [String] EC2 instance ID
+      # @return [TrueClass, FalseClass]
+      def halt_ec2_instance(parameters)
+        begin
+          compute_api(parameters[:region]).stop_instances([parameters[:instance_id]])
+          info "Halted EC2 instance: #{parameters[:instance_id]}"
+          true
+        rescue => e
+          warn "Failed to halt requested EC2 instance: #{parameters[:instance_id]} (#{e.class}: #{e.message})"
+          false
+        end
+      end
+
+      # Create new AMI using provided EC2 instance
+      #
+      # @param response [Hash] cfn response
+      # @param parameters [Hash] resource parameters
+      # @return [Hash] updated response hash
+      def generate_ami(response, parameters)
+        begin
+          result = compute_api(parameters[:region]).create_image(
+            parameters[:instance_id],
+            parameters[:name],
+            parameters[:description],
+            parameters[:no_reboot],
+            :block_device_mappings => parameters.fetch(:block_device_mappings, [])
+          )
+          info "New AMI registered: #{result.body['imageId']}"
+          response['Data']['AmiId'] = result.body['imageId']
+          response['PhysicalResourceId'] = [
+            physical_resource_id,
+            result.body['imageId']
+          ].join(PHYSICAL_ID_JOINER)
+        rescue ::Fog::Compute::AWS::Error => e
+          warn "Failed to create AMI: #{e.class}: #{e.message}"
+          response['Reason'] = "AMI Creation failed: #{e.message}"
+          response['Status'] = 'FAILED'
+        rescue => e
+          error "Unexpected error creating AMI: #{e.class}: #{e.message}"
+          response['Status'] = 'FAILED'
+          response['Reason'] = "Unexpected error: #{e.message}"
+          response['PhysicalResourceId'] = [
+            response['PhysicalResourceId'],
+            parameters[:ami_id]
+          ].join(PHYSICAL_ID_JOINER)
+        end
+        response
+      end
+
+      # Destroy the AMI referenced by the resource
+      #
+      # @param response [Hash] cfn response
+      # @param payload [Hash] message payload
+      # @param parameters [Hash] resource parameters
+      # @return [TrueClass]
+      def destroy_ami(response, payload, parameters)
+        ami_id = payload[:physical_resource_id].split(PHYSICAL_ID_JOINER).last
+        begin
+          info "Destroying registered AMI: #{ami_id}"
+          compute_api(parameters[:region]).deregister_image(ami_id)
+        rescue ::Fog::Compute::AWS::Error => e
+          warn "Failed to remove AMI: #{e.class}: #{e}"
+          response['Reason'] = "Failed to remove AMI resource: #{e}. Ignoring."
+        rescue => e
+          error "Unexpected error removing AMI: #{e.class}: #{e}"
+          response['Status'] = 'FAILED'
+          response['Reason'] = e.message
+        end
+        true
+      end
+
+      # Build new compute api connection
+      #
+      # @param region [String] AWS region ami exists
+      # @return [Fog::Compute]
+      def compute_api(region)
+        ::Fog::Compute.new(
+          {:provider => :aws}.merge(
+            config.get(:ami, :credentials, :compute).merge(
+              :region => region
+            )
+          )
+        )
+      end
+
+    end
+  end
+end

data/lib/jackal-cfn/version.rb

@@ -1,6 +1,6 @@
 module Jackal
   module Cfn
     # Current version
-    VERSION = Gem::Version.new('0.2.2')
+    VERSION = Gem::Version.new('0.2.4')
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jackal-cfn
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.4
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-17 00:00:00.000000000 Z
+date: 2015-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jackal
@@ -54,6 +54,7 @@ files:
 - lib/jackal-cfn/formatter/chef_cleanup.rb
 - lib/jackal-cfn/resource.rb
 - lib/jackal-cfn/resource/ami_manager.rb
+- lib/jackal-cfn/resource/ami_register.rb
 - lib/jackal-cfn/resource/hash_extractor.rb
 - lib/jackal-cfn/utils.rb
 - lib/jackal-cfn/utils/fog.rb
@@ -84,3 +85,4 @@ signing_key:
 specification_version: 4
 summary: Message processing helper
 test_files: []
+has_rdoc: