splunk-pickaxe 2.3.1 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 401ff0593d372a9b42471d760602c03b65701b1b
-  data.tar.gz: 76d5988dbb82b239ddf8122caf764f58bde00f85
+  metadata.gz: dcd56d84913d202840b8f0b807217044f0d057b6
+  data.tar.gz: 44fd867231ae53662d125bde0921a07da4486c8c
 SHA512:
-  metadata.gz: 538fda33e4d73b3e6d521ead1a72cd003ae70913633e56948472438f5a331c232e95ef6284907e9cfc7b9043854e8a413f42169eefb5626de5850d8b16ffa0c7
-  data.tar.gz: a85db84016c7db903b161eea60c46c92b50411a280546a89cf79fdfc6f6e94bcd0c01c5825ffa1a7c8e5489176b92a73a5cd78d9df5a70fee4b3683402823205
+  metadata.gz: 940928c1c49050bfdfa214c6b0508cd7ec201ea0c8aeaaf75bd2921b872a2397a08d7d7add36490ffdcc2464cb0c062d57ecb98b4bfb4b4edda2cf556f764b24
+  data.tar.gz: 552676b068ef457f0bcf95a0f489a17e5a65364e7c9da840eea77eea974598d788383ab0763789f465738d7e3b44dec33bc32edcd8d1d0621a97e896cd1e42df

data/README.md

@@ -36,7 +36,8 @@ namespace:
   app: MY_SPLUNK_APP
 
 environments:
-  ENVIRONMENT_NAME: SPLUNK_API_URL (i.e. https://search-head.my-splunk.com:8089)
+  ENVIRONMENT_NAME:
+    url: SPLUNK_API_URL (i.e. https://search-head.my-splunk.com:8089)
 ```
 
 Add some Splunk objects; see [example repo](example-repo) or below for manually
@@ -201,6 +202,40 @@ envs:
 By default if `envs` is not provided the object will be imported to all
 environments.
 
+All Splunk objects are processed through ERB before being loaded to allow for dynamic configuration.  The values from `.pickaxe.yml` provided within the environment configuration appropriate to the executed command will be added to the ERB binding during the rendering process.
+
+.pickaxe.yml
+```yaml
+namespace:
+  # The application in which to create the Splunk knowledge objects
+  app: MY_SPLUNK_APP
+
+environments:
+  ENVIRONMENT_NAME:
+    url: SPLUNK_API_URL (i.e. https://search-head.my-splunk.com:8089)
+    index_name: my_index
+```
+
+my_alert.yml
+```yaml
+name: ALERT NAME
+config:
+  # Search query of events used to trigger alert
+  search: >
+    MY SEARCH USING <%= index_name %>
+```
+
+Environment variables from the OS can also be referenced.
+
+my_alert.yml
+```yaml
+name: ALERT NAME
+config:
+  # Search query of events used to trigger alert
+  search: >
+    MY SEARCH USING <%= ENV['INDEX_NAME'] %>
+```
+
 Config
 ------
 
@@ -228,6 +263,7 @@ emails:
   - my.email@domain.com
 ```
 
+
 ### Backwards Compatibility
 
 In previous version the config used to look like this,

data/Rakefile

@@ -170,7 +170,13 @@ end
 
 def update_version version
   version_splits = version.split('.')
+
+  # Bump minor version up one
   version_splits[1] = (version_splits[1].to_i + 1).to_s
+
+  # Ensure fix version is reset
+  version_splits[2] = 0
+  
   next_version = version_splits.join('.')
 
   version_rb = IO.read('lib/splunk/pickaxe/version.rb')

data/lib/splunk/pickaxe/config.rb

@@ -24,7 +24,7 @@ module Splunk
         Config.new deep_merge(DEFAULTS, YAML.load_file(config_path)), environment, execution_path
       end
 
-      attr_reader :namespace, :environment, :execution_path, :emails, :url
+      attr_reader :namespace, :environment, :execution_path, :emails, :url, :env_config
 
       def initialize(config, environment, execution_path)
         raise "Config must have a 'namespace / app' config" unless config['namespace'].key?('app')
@@ -40,10 +40,12 @@ module Splunk
           puts "Your .pickaxe.yml is using a deprecated config format. Check https://github.com/cerner/splunk-pickaxe#backwards-compatibility for details"
           @emails = config['emails']
           @url = env_config
+          @env_config = { 'url' => @url, 'emails' => @emails }
         elsif env_config.is_a?(Hash)
           raise "url config is required for environment [#{environment}]" unless env_config.has_key?('url')
           @url = env_config['url']
           @emails = env_config.has_key?('emails') ? env_config['emails'] : config['emails']
+          @env_config = env_config
         else
           raise "Unexepcted value for environment [#{environment}] config. Expected String or Hash, saw #{config['environments'][environment]}"
         end

data/lib/splunk/pickaxe/erb_with_binding.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'ostruct'
+
+module Splunk
+  module Pickaxe
+    class ERBWithBinding < OpenStruct
+      def self.render_from_hash(t, h)
+        ERBWithBinding.new(h).render(t)
+      end
+
+      def render(template)
+        ERB.new(template).result(binding)
+      end
+    end
+  end
+end

data/lib/splunk/pickaxe/objects.rb

@@ -2,6 +2,7 @@
 
 require 'splunk-sdk-ruby'
 require 'yaml'
+require_relative 'erb_with_binding'
 
 # Base class for syncing splunk objects (dashboards, alerts, etc...)
 module Splunk
@@ -62,7 +63,9 @@ module Splunk
       end
 
       def config(file_path)
-        YAML.load_file file_path
+        template = File.read(file_path)
+        yaml_contents = ERBWithBinding::render_from_hash(template, pickaxe_config.env_config)
+        YAML.safe_load(yaml_contents, [], [], true)
       end
 
       def create(entity)

data/lib/splunk/pickaxe/objects/dashboards.rb

@@ -28,11 +28,14 @@ module Splunk
       end
 
       def config(file_path)
+        template = IO.read(file_path)
+        xml_content = ERBWithBinding::render_from_hash(template, pickaxe_config.env_config)
+
         # Dashboards don't have many properties just name and source XML
         {
           'name' => File.basename(file_path, '.xml'),
           'config' => {
-            'eai:data' => IO.read(file_path)
+            'eai:data' => xml_content
           }
         }
       end

data/lib/splunk/pickaxe/version.rb

@@ -2,6 +2,6 @@
 
 module Splunk
   module Pickaxe
-    VERSION = '2.3.1'
+    VERSION = '2.4.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: splunk-pickaxe
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.4.0
 platform: ruby
 authors:
 - Bryan Baugher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-26 00:00:00.000000000 Z
+date: 2018-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: splunk-sdk-ruby
@@ -97,6 +97,7 @@ files:
 - lib/splunk/pickaxe/client.rb
 - lib/splunk/pickaxe/config.rb
 - lib/splunk/pickaxe/cookie_proxy.rb
+- lib/splunk/pickaxe/erb_with_binding.rb
 - lib/splunk/pickaxe/objects.rb
 - lib/splunk/pickaxe/objects/alerts.rb
 - lib/splunk/pickaxe/objects/dashboards.rb