jackal-cfn 0.2.16 → 0.2.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c074ac269a3949f7b1e9554a1d3d301d7656195a
-  data.tar.gz: 75fd37b327ca6ee8c562ed0f2bfc4be4fb1e97a6
+  metadata.gz: d68462a480bb426c377656d7bc2ba63725dd1e61
+  data.tar.gz: 35b702d77313eaead8aac1d61e66ddbdbfb55f5c
 SHA512:
-  metadata.gz: 4f8d1552c3b1fc950357808137c461f0f21b06db494a9660d9cd9fbc67e69820dc503b8491e9a6d6b6ce3812d6a0274c88453ded523680672a282146764119b2
-  data.tar.gz: e6441d30aaaaa8fba8f69b40c157e38499d5c3530ac5f730d2f932d15784c9e33fee47b08534f79f61851d087785987f10f3555ea431fcda332313b6d5f3a950
+  metadata.gz: a49947efa919dc54ded09b699239054a7648747b474d2317ae7bef30f82a980c2a06ec6274462956abbbb4824c56d62502365f3368bc9984230a01b789a857fd
+  data.tar.gz: 0012138672f9a8c7eaccadba908166d0a053b441c292f11c6fa4de86b9caf1189efa8fa2af68ef72956f93208a2900718d5365114ee091570f10da4f06b61533

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# v0.2.18
+* [feature] Add OrchestrationUnit resource
+
 # v0.2.16
 * [feature] Allow image re-registration when options provided
 * [enhancement] Add resource scrubber helper

data/README.md

@@ -316,6 +316,77 @@ Configuration:
 }
 ```
 
+#### `Jackal::Cfn::OrchestrationUnit`
+
+This resource provides a custom "orchestration unit". The "orchestration unit" consists
+of a piece of code. It is similar to the `AWS::Lambda::Function` resource but is more
+freeform. The command to be executed can be provided as an inline string, or as a remote
+URL to a compressed zip file containing a `run.sh` file to execute. If the return value
+is JSON, the values will be accessible using the `Fn::GetAtt` intrinsic function on the
+resource.
+
+Resource Usage:
+
+```json
+{
+  "Type": "Custom::OrchestrationUnit",
+  "Properties": {
+    "Exec": "STRING_COMMAND",
+    "ExecZip": "REMOTE_URL_TO_ZIP",
+    "Env": {
+      "CUSTOM_ENV_VARS": "FOR_COMMAND"
+    },
+    "OnCreate": {
+      "Exec": "STRING_COMMAND",
+      "ExecZip": "REMOTE_URL_TO_ZIP",
+      "Env": {
+        "CUSTOM_ENV_VARS": "FOR_COMMAND"
+      }
+    },
+    "OnUpdate": {
+      "Exec": "STRING_COMMAND",
+      "ExecZip": "REMOTE_URL_TO_ZIP",
+      "Env": {
+        "CUSTOM_ENV_VARS": "FOR_COMMAND"
+      }
+    },
+    "OnDelete": {
+      "Exec": "STRING_COMMAND",
+      "ExecZip": "REMOTE_URL_TO_ZIP",
+      "Env": {
+        "CUSTOM_ENV_VARS": "FOR_COMMAND"
+      }
+    },
+
+  }
+}
+```
+
+The `Exec` inline string command has precedence over the `ExecZip` if both are provided. The
+root `Exec` or `ExecZip` are the default commands to be run on _any action_. Customized
+commands per action can be provided using the `OnCreate`, `OnUpdate`, or `OnDelete` properties.
+Environment variables defined in the root properties will be merged with environment variables
+defined for explicit action commands.
+
+Resource response:
+
+If command result is a non-JSON value:
+
+```json
+{
+  "OrchestrationUnitValue": "RESULT_OF_COMMAND"
+}
+```
+
+If the result of the command is a JSON value (for example `{"MyKey": "MyValue"}`):
+
+```json
+{
+  "MyKey": "MyValue",
+  "OrchestrationUnitValue": "{\"MyKey\": \"MyValue\"}"
+}
+```
+
 ## Info
 
 * Repository: https://github.com/carnviore-rb/jackal-cfn

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

@@ -0,0 +1,188 @@
+require 'jackal-cfn'
+
+module Jackal
+  module Cfn
+    # Execute arbitrary actions
+    #
+    # Expected resource:
+    #   {
+    #     "Type": "Custom::OrchestrationUnit",
+    #     "Properties": {
+    #       "Parameters": {
+    #         "OnCreate": {
+    #           "Exec": "SHELL_COMMAND",
+    #           "ExecZip": "DOWNLOAD_URI",
+    #           "Env": {
+    #           }
+    #         },
+    #         "OnUpdate": {
+    #           "Exec": "SHELL_COMMAND",
+    #           "ExecZip": "DOWNLOAD_URI",
+    #           "Env": {
+    #           }
+    #         },
+    #         "OnDelete": {
+    #           "Exec": "SHELL_COMMAND",
+    #           "ExecZip": "DOWNLOAD_URI",
+    #           "Env": {
+    #           }
+    #         },
+    #         "Exec": "SHELL_COMMAND",
+    #         "ExecZip": "DOWNLOAD_URI",
+    #         "Env": {
+    #         }
+    #       }
+    #     }
+    #   }
+    #
+    class OrchestrationUnit < Jackal::Cfn::Resource
+
+      # Execute orchestration unit
+      #
+      # @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)
+          unit = unit_for(cfn_resource[:request_type], parameters)
+          working_dir = create_working_directory(payload[:id])
+          run_unit(unit, working_dir, cfn_response)
+          FileUtils.rm_rf(working_dir)
+          respond_to_stack(cfn_response, cfn_resource[:response_url])
+          job_completed(:jackal_cfn, payload, message)
+        end
+      end
+
+      # Create a working directory for command execution
+      #
+      # @param uuid [String] unique identifier
+      # @return [String] path
+      def create_working_directory(uuid)
+        dir_path = File.join(
+          config.fetch(
+            :working_directory,
+            '/tmp/jackal-cfn'
+          ),
+          uuid
+        )
+        FileUtils.mkdir_p(dir_path)
+        dir_path
+      end
+
+      # Fetch compressed zip file from remote location and unpack into
+      # provided working directory
+      #
+      # @param unit [Hash] orchestration unit
+      # @param working_directory [String] local path to working directory
+      # @return [Hash] unit
+      # @note will automatically set `unit['Exec'] = './run.sh'`
+      def fetch_and_unpack_exec(unit, working_directory)
+        result = HTTP.get(unit[:exec_zip])
+        file = Tempfile.new('orchestration-unit')
+        while(data = result.body.readpartial(2048))
+          file.write data
+        end
+        file.flush
+        file.rewind
+        asset_store.unpack(file, working_directory)
+        unit[:exec] = File.join(working_directory, 'run.sh')
+        unit
+      end
+
+      # Run the unit and set result information into response
+      #
+      # @param unit [Hash] orchestration unit
+      # @param working_directory [String] path to local working directory
+      # @param response [Hash] CFN response
+      # @return [Hash] CFN response
+      def run_unit(unit, working_directory, response)
+        if(unit[:exec_zip])
+          fetch_and_unpack_exec(unit, working_directory)
+        end
+        if(unit[:exec])
+          result = Smash.new
+          process_manager.process(unit.hash, unit[:exec]) do |process|
+            stdout = process_manager.create_io_tmp(Carnivore.uuid, 'stdout')
+            stderr = process_manager.create_io_tmp(Carnivore.uuid, 'stderr')
+            process.io.stdout = stdout
+            process.io.stderr = stderr
+            process.cwd = working_directory
+            if(unit[:env])
+              process.environment.replace(unit[:env])
+            end
+            process.leader = true
+            result[:start_time] = Time.now.to_i
+            process.start
+            begin
+              process.poll_for_exit(config.fetch(:max_execution_time, 60))
+            rescue ChildProcess::TimeoutError
+              process.stop
+              result[:timed_out] = true
+            end
+            result[:stop_time] = Time.now.to_i
+            result[:exit_code] = process.exit_code
+            stdout.rewind
+            # TODO: size check
+            result[:content] = stdout.read
+            if(process.exit_code != 0)
+              stderr.rewind
+              result[:error_message] = stderr.read
+            end
+          end
+          if(result[:exit_code] == 0)
+            response['Data']['OrchestrationUnitResult'] = result[:content]
+            begin
+              j_result = MultiJson.load(result[:content])
+              response['Data'] = j_result.merge(response['Data'])
+            rescue MultiJson::ParseError => e
+              debug 'Command result not JSON data'
+            end
+            response
+          else
+            raise "Execution failed! Exit code: #{result[:exit_code]} Reason: #{result[:error_message]}"
+          end
+        else
+          response['Data']['OrchestrationUnitResult'] = 'No command executed!'
+          response
+        end
+      end
+
+      # Extract unit information based on received request type
+      #
+      # @param request_type [String] CFN request type
+      # @param parameters [Hash] resource parameters
+      # @return [Hash] orchestration unit
+      def unit_for(request_type, parameters)
+        base_key = "on_#{request_type.to_s.downcase}"
+        result = Smash.new
+        if(direct_unit = parameters[base_key])
+          [:exec, :exec_zip, :env].each do |p_key|
+            if(direct_unit[p_key])
+              result[p_key] = direct[p_key]
+            end
+          end
+        end
+        unless(result[:exec] || result[:exec_zip])
+          if(parameters[:exec])
+            result[:exec] = parameters[:exec]
+          elsif(parameters[:exec_zip])
+            result[:exec_zip] = parameters[:exec_zip]
+          end
+        end
+        if(parameters[:env])
+          if(result[:env])
+            result[:env] = parameters[:env].merge(result[:env])
+          else
+            result[:env] = parameters[:env]
+          end
+        end
+        result[:env] ||= Smash.new
+        result[:env]['CFN_REQUEST_TYPE'] = request_type.to_s.upcase
+        result
+      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.16')
+    VERSION = Gem::Version.new('0.2.18')
   end
 end

data/lib/jackal-cfn.rb

@@ -13,6 +13,7 @@ module Jackal
     autoload :AmiManager, 'jackal-cfn/resource/ami_manager'
     autoload :AmiRegister, 'jackal-cfn/resource/ami_register'
     autoload :JackalStack, 'jackal-cfn/resource/jackal_stack'
+    autoload :OrchestrationUnit, 'jackal-cfn/resource/orchestration_unit'
     autoload :Scrubber, 'jackal-cfn/resource/scrubber'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jackal-cfn
 version: !ruby/object:Gem::Version
-  version: 0.2.16
+  version: 0.2.18
 platform: ruby
 authors:
 - Chris Roberts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-18 00:00:00.000000000 Z
+date: 2016-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jackal
@@ -71,6 +71,7 @@ files:
 - lib/jackal-cfn/resource/ami_register.rb
 - lib/jackal-cfn/resource/hash_extractor.rb
 - lib/jackal-cfn/resource/jackal_stack.rb
+- lib/jackal-cfn/resource/orchestration_unit.rb
 - lib/jackal-cfn/resource/scrubber.rb
 - lib/jackal-cfn/utils.rb
 - lib/jackal-cfn/utils/fog.rb