splunk-pickaxe 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8bf76e38f6793776895f41afc8c1e345c1e0e3fe
-  data.tar.gz: b85f42c837a2d3deb8dee1c2db57406675389409
+  metadata.gz: e55da5bc5897dd51554a5022a5f3e123a721be1f
+  data.tar.gz: 7a3143d708b70cc5d9cee018b0caecfd40a90e2b
 SHA512:
-  metadata.gz: a309da7903abab3668482669ac16e332670fabc9aaa62a0ba5da0e529f51918c4eda4e2aaab5399063728178513dd38a835170969b7bf2380237d4711dd69684
-  data.tar.gz: e29feda288ce0bfc6a77b60b51cd779f09fcb9d217a3119be8a2790488c1219037a28398186eb560b1a739a406f7eb81a423740b99a0800ddd210011b1eb5f3d
+  metadata.gz: ec70d9d035c320c620c96ab4d00d02d77abc50abed86e2932297861e42446085fcb3a178578e4d8524c5aeb216c8ff64f0743651fea206b98b562e8e8c591dc3
+  data.tar.gz: 6d9d9dc450bf4c4833dcb9aec225e2f603e04d099119a5c99fa905309e1dc2beff82f163a983004653e27438dfaef2c547b7bd54031a57201c7463f46269d54c

data/Gemfile

@@ -9,3 +9,10 @@ group :test do
   gem 'rake', '~> 12.0'
   gem 'rspec', '~> 3.5'
 end
+
+gem 'pry-rails', :group => :development
+
+group :release do
+  gem 'octokit'
+  gem 'rubygems-tasks'
+end

data/README.md

@@ -1,9 +1,11 @@
 Splunk-Pickaxe
 ==============
 
-A tool for syncing your repo of Splunk objects with a Splunk instance(s).
+[![Build Status](https://travis-ci.org/cerner/splunk-pickaxe.svg?branch=master)](https://travis-ci.org/cerner/splunk-pickaxe)
 
-This provides a development workflow for Splunk components (i.e. dashboards,
+A tool for serializing and syncing your repo of Splunk objects across Splunk instances.
+
+This provides a development workflow for Splunk components (e.g., dashboards,
 alerts, reports, etc) and an easy way to apply them consistently.
 
 Getting Started
@@ -35,19 +37,22 @@ environments:
   ENVIRONMENT_NAME: SPLUNK_API_URL (i.e. https://search-head.my-splunk.com:8089)
 ```
 
-Add some Splunk objects. See [example repo](example-repo) or below for format.
-
-Sync your repo with Splunk,
+Add some Splunk objects; see [example repo](example-repo) or below for manually
+defining Splunk objects. Alternatively, to retrieve _all_ Splunk objects from
+an environment, run:
 
-    pickaxe sync ENVIRONMENT_NAME
+    pickaxe get ENVIONMENT_NAME
 
 Where `ENVIRONMENT_NAME` is the name of one of the environments configured in
 your `.pickaxe.yml`. These map to different Splunk instances.
 
-By default this command assumes the user running the command has a Splunk account
-and access to make these changes in the configured Splunk application. Your
-password will be requested when run. Alternatively you can make use of the
-options `--user` and `--password`.
+You may then modify any of these objects. Afterwards, sync your repo with Splunk:
+
+    pickaxe sync ENVIRONMENT_NAME
+
+By default these commands assume the user has a Splunk account and access to make these
+changes in the configured Splunk application. Your password will be requested when run.
+Alternatively you can make use of the options `--user` and `--password`.
 
 Splunk Objects
 --------------

data/Rakefile

@@ -1,7 +1,175 @@
 # frozen_string_literal: true
-
+require "rubygems"
 require 'rspec/core/rake_task'
 
+REPO = 'cerner/splunk-pickaxe'
+
 RSpec::Core::RakeTask.new(:test) do |t|
   t.rspec_opts = '--format documentation'
 end
+
+task :default => [:test]
+
+task :release do
+  intialize_octokit
+  puts "Releasing the gem ..."
+
+  spec = Gem::Specification::load("splunk-pickaxe.gemspec")
+  version = spec.version.to_s
+
+  # Update change log
+  puts "Updating change log ..."
+  update_change_log version
+  puts "Change log updated!"
+
+  run_command 'gem build splunk-pickaxe.gemspec'
+  run_command "gem push splunk-pickaxe-#{version}.gem"
+
+  update_version version
+end
+
+task :build_change_log do
+  intialize_octokit
+  closed_milestones = @octokit.milestones REPO, {:state => "closed"}
+
+  version_to_milestone = Hash.new
+  versions = Array.new
+
+  closed_milestones.each do |milestone|
+    version = Gem::Version.new(milestone.title)
+    version_to_milestone.store version, milestone
+    versions.push version
+  end
+
+  versions = versions.sort.reverse
+
+  change_log = File.open('CHANGELOG.md', 'w')
+
+  begin
+    change_log.write "Change Log\n"
+    change_log.write "==========\n"
+    change_log.write "\n"
+
+    versions.each do |version|
+      milestone = version_to_milestone[version]
+      change_log.write generate_milestone_markdown(milestone)
+      change_log.write "\n"
+    end
+  ensure
+    change_log.close
+  end
+end
+
+def intialize_octokit
+  require 'octokit'
+  if ENV['GITHUB_API_TOKEN']
+    @octokit = Octokit::Client.new(:access_token => ENV['GITHUB_API_TOKEN'])
+  else
+    @octokit = Octokit::Client.new
+  end
+end
+
+def update_change_log version
+  change_log_lines = IO.read(File.join(File.dirname(__FILE__), 'CHANGELOG.md')).split("\n")
+
+  change_log = File.open('CHANGELOG.md', 'w')
+
+  begin
+
+    # Keep change log title
+    change_log.write change_log_lines.shift
+    change_log.write "\n"
+    change_log.write change_log_lines.shift
+    change_log.write "\n"
+    change_log.write "\n"
+
+    # Write new milestone info
+    change_log.write generate_milestone_markdown(milestone(version))
+
+    # Add previous change log info
+    change_log_lines.each do |line|
+      change_log.write line
+      change_log.write "\n"
+    end
+
+  ensure
+    change_log.close
+  end
+
+  run_command "git add CHANGELOG.md"
+  run_command "git commit -m 'Added #{version} to change log'"
+  run_command "git push origin HEAD"
+end
+
+def generate_milestone_markdown milestone
+  strings = Array.new
+
+  title = "[#{milestone.title} - #{milestone.updated_at.strftime("%m-%d-%Y")}](https://github.com/#{REPO}/issues?milestone=#{milestone.number}&state=closed)"
+
+  strings.push "#{title}"
+  strings.push "-" * title.length
+  strings.push ""
+
+  issues = @octokit.issues REPO, {:milestone => milestone.number, :state => "closed"}
+
+  issues.each do |issue|
+    strings.push "  * [#{issue_type issue}] [Issue-#{issue.number}](https://github.com/#{REPO}/issues/#{issue.number}) : #{issue.title}"
+  end
+
+  strings.push ""
+
+  strings.join "\n"
+end
+
+def milestone version
+  closedMilestones = @octokit.milestones REPO, {:state => "closed"}
+
+  closedMilestones.each do |milestone|
+    if milestone["title"] == version
+      return milestone
+    end
+  end
+
+  openMilestones = @octokit.milestones REPO
+
+  openMilestones.each do |milestone|
+    if milestone["title"] == version
+      return milestone
+    end
+  end
+
+  raise "Unable to find milestone with title [#{version}]"
+end
+
+def issue_type issue
+  labels = Array.new
+  issue.labels.each do |label|
+    labels.push label.name.capitalize
+  end
+  labels.join "/"
+end
+
+def run_command command
+  output = `#{command}`
+  unless $?.success?
+    raise "Command : [#{command}] failed.\nOutput : \n#{output}"
+  end
+end
+
+def update_version version
+  version_splits = version.split('.')
+  version_splits[1] = (version_splits[1].to_i + 1).to_s
+  next_version = version_splits.join('.')
+
+  version_rb = IO.read('lib/splunk/pickaxe/version.rb')
+  new_version_rb = version_rb
+    .split("\n")
+    .map{|line| line.include?('VERSION =') ? "    VERSION = '#{next_version}'" : line }
+    .join("\n")
+
+  File.write('lib/splunk/pickaxe/version.rb', new_version_rb)
+
+  run_command "git add lib/splunk/pickaxe/version.rb"
+  run_command "git commit -m 'Updated version to #{next_version}'"
+  run_command "git push origin HEAD"
+end

data/lib/splunk/pickaxe/cli.rb

@@ -54,6 +54,21 @@ module Splunk
         pickaxe = Pickaxe.configure environment, user, password, execution_path
         pickaxe.sync_all
       end
+
+      desc 'save ENVIRONMENT', 'save remote configurations from the given environment'
+      option :user, type: :string, desc: 'The user to login to splunk with. If this is not provide it will use the current user'
+      option :password, type: :string, desc: 'The password to login to splunk with. If this is not provided it will ask for a password'
+      option :repo_path, type: :string, desc: 'The path to the repo. If this is not specified it is assumed you are executing from within the repo'
+      def save(environment)
+        cli = HighLine.new
+
+        user = options[:user] || Etc.getlogin
+        password = options[:password] || cli.ask('Password: ') { |o| o.echo = '*' }
+        execution_path = options[:repo_path] || Dir.getwd
+
+        pickaxe = Pickaxe.configure environment, user, password, execution_path
+        pickaxe.save_all
+      end
     end
   end
 end

data/lib/splunk/pickaxe/client.rb

@@ -31,6 +31,15 @@ module Splunk
         @tags.sync
         @field_extractions.sync
       end
+
+      def save_all
+        @alerts.save
+        @dashboards.save
+        @eventtypes.save
+        @reports.save
+        # splunk-sdk doesn't seem to support iterating tags
+        @field_extractions.save
+      end
     end
   end
 end

data/lib/splunk/pickaxe/config.rb

@@ -59,7 +59,6 @@ module Splunk
 
         copy
       end
-
     end
   end
 end

data/lib/splunk/pickaxe/objects.rb

@@ -86,6 +86,30 @@ module Splunk
         end
       end
 
+      def save
+        puts "Saving all #{entity_dir.capitalize}"
+
+        Splunk::Collection.new(service, splunk_resource)
+                          .map { |e| save_config e }
+      end
+
+      def save_config(splunk_entity)
+        file_path = entity_file_path splunk_entity
+
+        puts "- #{splunk_entity.name}"
+        if File.exist? file_path
+          puts '  Already exists'
+        else
+          File.write(file_path, {
+            'name' => splunk_entity.name,
+            'config' => splunk_entity_keys
+                          .map { |k| { k => splunk_entity.fetch(k) } }
+                          .reduce({}) { |memo, setting| memo.update(setting) }
+          }.to_yaml)
+          puts ' Created'
+        end
+      end
+
       def needs_update?(splunk_entity, entity)
         splunk_config(entity).each do |k, v|
           return true if splunk_entity[k] != v
@@ -99,6 +123,7 @@ module Splunk
         !entity['envs'].include?(environment)
       end
 
+      # Saved Splunk object's name
       def name(entity)
         entity['name']
       end
@@ -107,6 +132,10 @@ module Splunk
         entity['config']
       end
 
+      def entity_file_name(entity)
+        "#{entity.name}.yml".gsub(/[^a-z0-9_\-. ]/i, '')
+      end
+
       def entity_file_extensions
         ['.yml', '.yaml']
       end
@@ -120,6 +149,16 @@ module Splunk
         # Must be implemented by child class
         nil
       end
+
+      def splunk_entity_keys
+        # Must be implemented by child class
+        nil
+      end
+
+      def entity_file_path
+        # Must be implemented by child class
+        nil
+      end
     end
   end
 end

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

@@ -2,6 +2,7 @@
 
 require 'yaml'
 require 'splunk/pickaxe/objects'
+require 'splunk/pickaxe/objects/supported_keys'
 
 module Splunk
   module Pickaxe
@@ -16,6 +17,13 @@ module Splunk
         DIR
       end
 
+      def entity_file_path(splunk_entity)
+        File.join(
+          pickaxe_config.execution_path, entity_dir,
+          entity_file_name(splunk_entity)
+        )
+      end
+
       def name(entity)
         # The alert name contains the environment name
         "#{entity['name']} [#{environment.capitalize}]"
@@ -72,6 +80,10 @@ module Splunk
           'alert.suppress' => '0'
         }
       end
+
+      def splunk_entity_keys
+        Splunk::Pickaxe::ALERT_KEYS
+      end
     end
   end
 end

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

@@ -15,6 +15,18 @@ module Splunk
         DIR
       end
 
+      def entity_file_name(entity)
+        "#{entity['label']}.xml".gsub(/[^a-z0-9_\-. ]/i, '')
+                                .tr(' ', '_')
+      end
+
+      def entity_file_path(splunk_entity)
+        File.join(
+          pickaxe_config.execution_path, entity_dir,
+          entity_file_name(splunk_entity)
+        )
+      end
+
       def config(file_path)
         # Dashboards don't have many properties just name and source XML
         {
@@ -28,6 +40,18 @@ module Splunk
       def entity_file_extensions
         ['.xml']
       end
+
+      def save_config(splunk_entity)
+        file_path = entity_file_path splunk_entity
+
+        puts "- #{splunk_entity['label']}"
+        if File.exist? file_path
+          puts '  Already exists'
+        else
+          File.write(file_path, splunk_entity['eai:data'])
+          puts '  Created'
+        end
+      end
     end
   end
 end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'yaml'
 require 'splunk/pickaxe/objects'
+require 'splunk/pickaxe/objects/supported_keys'
 
 module Splunk
   module Pickaxe
@@ -15,6 +15,17 @@ module Splunk
       def entity_dir
         DIR
       end
+
+      def entity_file_path(splunk_entity)
+        File.join(
+          pickaxe_config.execution_path, entity_dir,
+          entity_file_name(splunk_entity)
+        )
+      end
+
+      def splunk_entity_keys
+        Splunk::Pickaxe::EVENT_TYPES_KEYS
+      end
     end
   end
 end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'splunk/pickaxe/objects'
+require 'splunk/pickaxe/objects/supported_keys'
 
 module Splunk
   module Pickaxe
@@ -15,6 +16,18 @@ module Splunk
         DIR
       end
 
+      def entity_file_name(splunk_entity)
+        "#{splunk_entity['stanza']}-#{splunk_entity['type']}-#{splunk_entity['attribute']}.yml"
+          .gsub(/[^a-z0-9_\-. ]/i, '')
+      end
+
+      def entity_file_path(splunk_entity)
+        File.join(
+          pickaxe_config.execution_path, entity_dir,
+          entity_file_name(splunk_entity)
+        )
+      end
+
       def find(entity)
         # Splunk does some fun things by re-naming our field extraction to include
         # the stanza and type in the name when its created so do that here by
@@ -33,6 +46,35 @@ module Splunk
         # When updating splunk only cares about this field
         splunk_entity['value'] != splunk_config(entity)['value']
       end
+
+      def save_config(splunk_entity)
+        file_path = entity_file_path splunk_entity
+
+        puts "- #{splunk_entity.name}"
+        if File.exist? file_path
+          puts '  Already exists'
+        else
+          config = splunk_entity_keys
+                   .map { |k| { k => splunk_entity.fetch(k) } }
+                   .reduce({}) { |memo, setting| memo.update(setting) }
+          # the POST api expects 'type' to be the first part of 'attribute'
+          # while the GET api returns 'type' within 'attribute'
+          # the GET api also command and space delimits values, it should only
+          # use commas OR spaces.
+          config['type'] = splunk_entity.fetch('attribute').split('-').first
+          config['value'].gsub!(/, /, ',')
+
+          File.write(file_path, {
+            'name' => splunk_entity.name,
+            'config' => config
+          }.to_yaml)
+          puts ' Created'
+        end
+      end
+
+      def splunk_entity_keys
+        Splunk::Pickaxe::FIELD_EXTRACTIONS_KEYS
+      end
     end
   end
 end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'yaml'
 require 'splunk/pickaxe/objects'
+require 'splunk/pickaxe/objects/supported_keys'
 
 module Splunk
   module Pickaxe
@@ -16,6 +16,13 @@ module Splunk
         DIR
       end
 
+      def entity_file_path(splunk_entity)
+        File.join(
+          pickaxe_config.execution_path, entity_dir,
+          entity_file_name(splunk_entity)
+        )
+      end
+
       def name(entity)
         # The report name contains the environment name
         "#{entity['name']} [#{environment.capitalize}]"
@@ -61,6 +68,10 @@ module Splunk
           'dispatch.latest_time' => 'now'
         }
       end
+
+      def splunk_entity_keys
+        Splunk::Pickaxe::REPORT_KEYS
+      end
     end
   end
 end

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

@@ -0,0 +1,10 @@
+# rubocop:disable Metrics/LineLength
+
+module Splunk
+  module Pickaxe
+    ALERT_KEYS = %w[action.email action.email.sendresults action.email.to action.populate_lookup action.rss action.script action.summary_index actions alert.digest_mode alert.expires alert.severity alert.suppress alert.suppress.fields alert.suppress.period alert.track alert_comparator alert_condition alert_threshold alert_type auto_summarize auto_summarize.command auto_summarize.cron_schedule auto_summarize.dispatch.earliest_time auto_summarize.dispatch.latest_time auto_summarize.dispatch.time_format auto_summarize.dispatch.ttl auto_summarize.max_concurrent auto_summarize.max_disabled_buckets auto_summarize.max_summary_ratio auto_summarize.max_summary_size auto_summarize.max_time auto_summarize.suspend_period auto_summarize.timespan cron_schedule description disabled dispatch.auto_cancel dispatch.auto_pause dispatch.buckets dispatch.earliest_time dispatch.index_earliest dispatch.index_latest dispatch.indexedRealtime dispatch.latest_time dispatch.lookups dispatch.max_count dispatch.max_time dispatch.reduce_freq dispatch.rt_backfill dispatch.spawn_process dispatch.time_format dispatch.ttl dispatchAs display.events.fields display.events.list.drilldown display.events.list.wrap display.events.maxLines display.events.raw.drilldown display.events.rowNumbers display.events.table.drilldown display.events.table.wrap display.events.type display.general.enablePreview display.general.migratedFromViewState display.general.timeRangePicker.show display.general.type display.page.search.mode display.page.search.patterns.sensitivity display.page.search.showFields display.page.search.tab display.page.search.timeline.format display.page.search.timeline.scale display.statistics.drilldown display.statistics.overlay display.statistics.rowNumbers display.statistics.show display.statistics.wrap display.visualizations.chartHeight display.visualizations.charting.axisLabelsX.majorLabelStyle.overflowMode display.visualizations.charting.axisLabelsX.majorLabelStyle.rotation display.visualizations.charting.axisLabelsX.majorUnit display.visualizations.charting.axisLabelsY.majorUnit display.visualizations.charting.axisLabelsY2.majorUnit display.visualizations.charting.axisTitleX.text display.visualizations.charting.axisTitleX.visibility display.visualizations.charting.axisTitleY.text display.visualizations.charting.axisTitleY.visibility display.visualizations.charting.axisTitleY2.text display.visualizations.charting.axisTitleY2.visibility display.visualizations.charting.axisX.maximumNumber display.visualizations.charting.axisX.minimumNumber display.visualizations.charting.axisX.scale display.visualizations.charting.axisY.maximumNumber display.visualizations.charting.axisY.minimumNumber display.visualizations.charting.axisY.scale display.visualizations.charting.axisY2.enabled display.visualizations.charting.axisY2.maximumNumber display.visualizations.charting.axisY2.minimumNumber display.visualizations.charting.axisY2.scale display.visualizations.charting.chart display.visualizations.charting.chart.bubbleMaximumSize display.visualizations.charting.chart.bubbleMinimumSize display.visualizations.charting.chart.bubbleSizeBy display.visualizations.charting.chart.nullValueMode display.visualizations.charting.chart.overlayFields display.visualizations.charting.chart.rangeValues display.visualizations.charting.chart.showDataLabels display.visualizations.charting.chart.sliceCollapsingThreshold display.visualizations.charting.chart.stackMode display.visualizations.charting.chart.style display.visualizations.charting.drilldown display.visualizations.charting.gaugeColors display.visualizations.charting.layout.splitSeries display.visualizations.charting.layout.splitSeries.allowIndependentYRanges display.visualizations.charting.legend.labelStyle.overflowMode display.visualizations.charting.legend.placement display.visualizations.mapHeight display.visualizations.mapping.choroplethLayer.colorBins display.visualizations.mapping.choroplethLayer.colorMode display.visualizations.mapping.choroplethLayer.maximumColor display.visualizations.mapping.choroplethLayer.minimumColor display.visualizations.mapping.choroplethLayer.neutralPoint display.visualizations.mapping.choroplethLayer.shapeOpacity display.visualizations.mapping.choroplethLayer.showBorder display.visualizations.mapping.data.maxClusters display.visualizations.mapping.drilldown display.visualizations.mapping.map.center display.visualizations.mapping.map.panning display.visualizations.mapping.map.scrollZoom display.visualizations.mapping.map.zoom display.visualizations.mapping.markerLayer.markerMaxSize display.visualizations.mapping.markerLayer.markerMinSize display.visualizations.mapping.markerLayer.markerOpacity display.visualizations.mapping.showTiles display.visualizations.mapping.tileLayer.maxZoom display.visualizations.mapping.tileLayer.minZoom display.visualizations.mapping.tileLayer.tileOpacity display.visualizations.mapping.tileLayer.url display.visualizations.mapping.type display.visualizations.show display.visualizations.singlevalue.afterLabel display.visualizations.singlevalue.beforeLabel display.visualizations.singlevalue.colorBy display.visualizations.singlevalue.colorMode display.visualizations.singlevalue.numberPrecision display.visualizations.singlevalue.rangeColors display.visualizations.singlevalue.rangeValues display.visualizations.singlevalue.showSparkline display.visualizations.singlevalue.showTrendIndicator display.visualizations.singlevalue.trendColorInterpretation display.visualizations.singlevalue.trendDisplayMode display.visualizations.singlevalue.trendInterval display.visualizations.singlevalue.underLabel display.visualizations.singlevalue.useColors display.visualizations.singlevalue.useThousandSeparators display.visualizations.singlevalueHeight display.visualizations.type displayview is_scheduled is_visible max_concurrent next_scheduled_time qualifiedSearch realtime_schedule request.ui_dispatch_app request.ui_dispatch_view restart_on_searchpeer_add run_n_times run_on_startup schedule_window search vsid].freeze
+    EVENT_TYPES_KEYS = %w[description disabled priority search tags].freeze
+    FIELD_EXTRACTIONS_KEYS = %w[stanza type value].freeze
+    REPORT_KEYS = %w[action.email action.email.sendresults action.email.to action.populate_lookup action.rss action.script action.summary_index actions alert.digest_mode alert.expires alert.severity alert.suppress alert.suppress.fields alert.suppress.period alert.track alert_comparator alert_condition alert_threshold alert_type auto_summarize auto_summarize.command auto_summarize.cron_schedule auto_summarize.dispatch.earliest_time auto_summarize.dispatch.latest_time auto_summarize.dispatch.time_format auto_summarize.dispatch.ttl auto_summarize.max_concurrent auto_summarize.max_disabled_buckets auto_summarize.max_summary_ratio auto_summarize.max_summary_size auto_summarize.max_time auto_summarize.suspend_period auto_summarize.timespan cron_schedule description disabled dispatch.auto_cancel dispatch.auto_pause dispatch.buckets dispatch.earliest_time dispatch.index_earliest dispatch.index_latest dispatch.indexedRealtime dispatch.latest_time dispatch.lookups dispatch.max_count dispatch.max_time dispatch.reduce_freq dispatch.rt_backfill dispatch.spawn_process dispatch.time_format dispatch.ttl dispatchAs display.events.fields display.events.list.drilldown display.events.list.wrap display.events.maxLines display.events.raw.drilldown display.events.rowNumbers display.events.table.drilldown display.events.table.wrap display.events.type display.general.enablePreview display.general.migratedFromViewState display.general.timeRangePicker.show display.general.type display.page.search.mode display.page.search.patterns.sensitivity display.page.search.showFields display.page.search.tab display.page.search.timeline.format display.page.search.timeline.scale display.statistics.drilldown display.statistics.overlay display.statistics.rowNumbers display.statistics.show display.statistics.wrap display.visualizations.chartHeight display.visualizations.charting.axisLabelsX.majorLabelStyle.overflowMode display.visualizations.charting.axisLabelsX.majorLabelStyle.rotation display.visualizations.charting.axisLabelsX.majorUnit display.visualizations.charting.axisLabelsY.majorUnit display.visualizations.charting.axisLabelsY2.majorUnit display.visualizations.charting.axisTitleX.text display.visualizations.charting.axisTitleX.visibility display.visualizations.charting.axisTitleY.text display.visualizations.charting.axisTitleY.visibility display.visualizations.charting.axisTitleY2.text display.visualizations.charting.axisTitleY2.visibility display.visualizations.charting.axisX.maximumNumber display.visualizations.charting.axisX.minimumNumber display.visualizations.charting.axisX.scale display.visualizations.charting.axisY.maximumNumber display.visualizations.charting.axisY.minimumNumber display.visualizations.charting.axisY.scale display.visualizations.charting.axisY2.enabled display.visualizations.charting.axisY2.maximumNumber display.visualizations.charting.axisY2.minimumNumber display.visualizations.charting.axisY2.scale display.visualizations.charting.chart display.visualizations.charting.chart.bubbleMaximumSize display.visualizations.charting.chart.bubbleMinimumSize display.visualizations.charting.chart.bubbleSizeBy display.visualizations.charting.chart.nullValueMode display.visualizations.charting.chart.overlayFields display.visualizations.charting.chart.rangeValues display.visualizations.charting.chart.showDataLabels display.visualizations.charting.chart.sliceCollapsingThreshold display.visualizations.charting.chart.stackMode display.visualizations.charting.chart.style display.visualizations.charting.drilldown display.visualizations.charting.gaugeColors display.visualizations.charting.layout.splitSeries display.visualizations.charting.layout.splitSeries.allowIndependentYRanges display.visualizations.charting.legend.labelStyle.overflowMode display.visualizations.charting.legend.placement display.visualizations.mapHeight display.visualizations.mapping.choroplethLayer.colorBins display.visualizations.mapping.choroplethLayer.colorMode display.visualizations.mapping.choroplethLayer.maximumColor display.visualizations.mapping.choroplethLayer.minimumColor display.visualizations.mapping.choroplethLayer.neutralPoint display.visualizations.mapping.choroplethLayer.shapeOpacity display.visualizations.mapping.choroplethLayer.showBorder display.visualizations.mapping.data.maxClusters display.visualizations.mapping.drilldown display.visualizations.mapping.map.center display.visualizations.mapping.map.panning display.visualizations.mapping.map.scrollZoom display.visualizations.mapping.map.zoom display.visualizations.mapping.markerLayer.markerMaxSize display.visualizations.mapping.markerLayer.markerMinSize display.visualizations.mapping.markerLayer.markerOpacity display.visualizations.mapping.showTiles display.visualizations.mapping.tileLayer.maxZoom display.visualizations.mapping.tileLayer.minZoom display.visualizations.mapping.tileLayer.tileOpacity display.visualizations.mapping.tileLayer.url display.visualizations.mapping.type display.visualizations.show display.visualizations.singlevalue.afterLabel display.visualizations.singlevalue.beforeLabel display.visualizations.singlevalue.colorBy display.visualizations.singlevalue.colorMode display.visualizations.singlevalue.numberPrecision display.visualizations.singlevalue.rangeColors display.visualizations.singlevalue.rangeValues display.visualizations.singlevalue.showSparkline display.visualizations.singlevalue.showTrendIndicator display.visualizations.singlevalue.trendColorInterpretation display.visualizations.singlevalue.trendDisplayMode display.visualizations.singlevalue.trendInterval display.visualizations.singlevalue.underLabel display.visualizations.singlevalue.useColors display.visualizations.singlevalue.useThousandSeparators display.visualizations.singlevalueHeight display.visualizations.type displayview is_scheduled is_visible max_concurrent next_scheduled_time qualifiedSearch realtime_schedule request.ui_dispatch_app request.ui_dispatch_view restart_on_searchpeer_add run_n_times run_on_startup schedule_window search vsid].freeze
+  end
+end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'yaml'
 require 'splunk/pickaxe/objects'
+require 'splunk/pickaxe/objects/supported_keys'
 
 module Splunk
   module Pickaxe
@@ -16,6 +16,13 @@ module Splunk
         DIR
       end
 
+      def entity_file_path(splunk_entity)
+        File.join(
+          pickaxe_config.execution_path, entity_dir,
+          entity_file_name(splunk_entity)
+        )
+      end
+
       # Tags do not follow the typical conventions that other splunk resources do
       # so we have to change the find/create/update methods
       def find(entity)
@@ -60,6 +67,10 @@ module Splunk
         # Compares the fields in our config vs whats in splunk
         splunk_config(entity).uniq.sort != splunk_entity.uniq.sort
       end
+
+      def splunk_entity_keys
+        Splunk::Pickaxe::TAGS_KEYS
+      end
     end
   end
 end

data/lib/splunk/pickaxe/version.rb

@@ -2,6 +2,6 @@
 
 module Splunk
   module Pickaxe
-    VERSION = '2.0.0'
+    VERSION = '2.1.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: splunk-pickaxe
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Bryan Baugher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-10 00:00:00.000000000 Z
+date: 2017-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: splunk-sdk-ruby
@@ -102,9 +102,9 @@ files:
 - lib/splunk/pickaxe/objects/eventtypes.rb
 - lib/splunk/pickaxe/objects/field_extractions.rb
 - lib/splunk/pickaxe/objects/reports.rb
+- lib/splunk/pickaxe/objects/supported_keys.rb
 - lib/splunk/pickaxe/objects/tags.rb
 - lib/splunk/pickaxe/version.rb
-- project.yml
 homepage: http://github.com/Cerner/splunk-pickaxe
 licenses:
 - Apache-2.0

data/project.yml

@@ -1,34 +0,0 @@
-name: splunk-pickaxe
-group_id: com.cerner.bigdata
-artifact_id: splunk-pickaxe
-github:
-  project_url: http://github.cerner.com/bigdata/splunk-pickaxe
-
-doc: rdoc
-test: rake
-
-philter:
-  linters:
-    - ruby
-  ruby:
-    exclusions:
-      - target/**/*
-      - vendor/**/*
-      - spec/**/*
-
-jira:
-  url: https://jira.cerner.com
-  component: 25899
-
-snapshot_repository:
-  id: cerner-rubygems-snapshot
-  url: http://repo.snapshot.cerner.corp/rubygems/
-snapshot_site_repository:
-  id: bigdata-snapshot-site
-  url: http://repo.bigdata.cerner.corp/nexus/content/repositories/bigdata-snapshot-site/
-repository:
-  id: cerner-rubygems-internal
-  url: http://repo.release.cerner.corp/internal/rubygems/
-site_repository:
-  id: cerner-main-internal-site
-  url: http://repo.release.cerner.corp/internal/site/