splunk-pickaxe 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e30eda1563101ee3bf15dfaff58b4bcfcccc3d54
-  data.tar.gz: 553fcc43e768862110d4acd75dcd596a77db4424
+  metadata.gz: 62373e733e325efa667b008d470ab7328a54d0b2
+  data.tar.gz: a550e3b13ef3c880242d007235ee5938f8a38b4b
 SHA512:
-  metadata.gz: c7d145f55702162f5c336c5fea2b63120434249f29f0583351e765cfe1034777051913cdbc792078a647e807955173a2d5ffdf69c193afa8a53a759ea60b59b8
-  data.tar.gz: 2982d1bdc9a7c8e8f1933311cd885d2130fd1e841e73dc1a592e2f45493135211e31b2542cb0a63e19d98f5b76fd3be2e4c7e77f2705dfd01c7b66fb772cb512
+  metadata.gz: d0c54ba54629fd768b88b648ce7a6dc696cacdb78e3080287a8a06b483c9bb40d411c4161d75bb4f549024f183b0689bd14aaa97172e471ef9223ceaaa12c903
+  data.tar.gz: 7f53828e1077ffca6f0b3f197a216d43f028c7d9dffc1f2efddb415409d4776942b204fbd09db1a87e212dabd5bd58347c6a41f54cd80ddee7c1088cdd71ea56

data/README.md

@@ -43,7 +43,7 @@ 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 get ENVIONMENT_NAME
+    pickaxe save ENVIRONMENT_NAME
 
 Where `ENVIRONMENT_NAME` is the name of one of the environments configured in
 your `.pickaxe.yml`. These map to different Splunk instances.
@@ -204,13 +204,69 @@ environments.
 Config
 ------
 
-The `.pickaxe.yml` file contains the config for your Splunk resources. You can add,
+The `.pickaxe.yml` file contains the config for your Splunk resources and should
+look like this,
+
+```yaml
+namespace:
+  # The application name to create the splunk dashboards, alerts, reports, tags, etc...
+  app: my_splunk_app
+
+environments:
+  dev:
+    url: https://logs-api.dev.my-splunk.com
+  staging:
+    url: https://logs-api.staging.my-splunk.com
+  prod:
+    url: https://logs-api.prod.my-splunk.com
+    # Optional and will default to the root emails config
+    emails:
+      - my.email@domain.com
+
+# Used for any environments that don't specify emails config
+emails:
+  - my.email@domain.com
+```
+
+### Backwards Compatibility
+
+In previous version the config used to look like this,
+
+```yaml
+namespace:
+  app: my_splunk_app
+
+environments:
+  dev: https://logs-api.dev.my-splunk.com
+  staging: https://logs-api.staging.my-splunk.com
+  prod: https://logs-api.prod.my-splunk.com
+
+emails:
+  - my.email@domain.com
+```
+
+Specifically the value for each environment was a String that was the URL for
+the Splunk API. The new config format has the environment value as a Hash like
+this,
+
+```yaml
+namespace:
+  app: my_splunk_app
+
+environments:
+  dev:
+    url: https://logs-api.dev.my-splunk.com
+  staging:
+    url: https://logs-api.staging.my-splunk.com
+  prod:
+    url: https://logs-api.prod.my-splunk.com
+
+emails:
+  - my.email@domain.com
+```
 
-* `environments` : A hash of environment names (key) to Splunk url
-* `namespace`:
-    * `app`: The name of your Splunk application to deploy objects to
-    * `sharing`: The sharing settings for the Splunk resources (default=`app`)
-* `emails`: An array of emails used for all reports and alerts (default=`[]`)
+The previous format is still supported but deprecated and will be removed in the
+future.
 
 Contributing
 ------------

data/lib/splunk/pickaxe.rb

@@ -9,11 +9,11 @@ require 'splunk/pickaxe/cookie_proxy'
 module Splunk
   module Pickaxe
     def self.configure(environment, username, password, args)
-      config = Config.load(args.fetch(:repo_path, Dir.getwd))
+      config = Config.load(environment, args.fetch(:repo_path, Dir.getwd))
 
       raise "Unknown environment [#{environment}]. Expected #{config.environments.keys}" unless config.environments.key?(environment)
 
-      uri = URI(config.environments[environment])
+      uri = URI(config.url)
 
       puts "Connecting to splunk [#{uri}]"
       service = Splunk.connect(

data/lib/splunk/pickaxe/cli.rb

@@ -34,9 +34,10 @@ module Splunk
           f.puts 'namespace:'
           f.puts '  app: TODO'
           f.puts 'environments:'
-          f.puts '  MY_ENV: SPLUNK_API_URL'
-          f.puts 'emails:'
-          f.puts '  - my.email@domain.com'
+          f.puts '  MY_ENV:'
+          f.puts '    url: SPLUNK_API_URL'
+          f.puts '    emails:'
+          f.puts '      - my.email@domain.com'
         end
       end
 

data/lib/splunk/pickaxe/config.rb

@@ -16,27 +16,37 @@ module Splunk
         'emails' => [],
       }.freeze
 
-      def self.load(execution_path)
+      def self.load(environment, execution_path)
         config_path = File.join(execution_path, CONFIG_FILE)
         raise "Unable to load config file [#{config_path}]" unless File.exist? config_path
 
         # Merges DEFAULTS with yaml config
-        Config.new deep_merge(DEFAULTS, YAML.load_file(config_path)), execution_path
+        Config.new deep_merge(DEFAULTS, YAML.load_file(config_path)), environment, execution_path
       end
 
-      attr_reader :config, :namespace, :environments, :execution_path
+      attr_reader :namespace, :environment, :execution_path, :emails, :url
 
-      def initialize(config, execution_path)
-        unless config['namespace'].key? 'app'
-          raise "Config must have a 'namespace / app' config"
-        end
-
-        raise "Must have at least one environment" unless config['environments'].size > 0
+      def initialize(config, environment, execution_path)
+        raise "Config must have a 'namespace / app' config" unless config['namespace'].key?('app')
+        raise "Environment [#{environment}] is not configured" unless config['environments'].has_key?(environment)
 
-        @config = config
         @execution_path = execution_path
+        @environment = environment
 
-        @environments = config['environments']
+        env_config = config['environments'][environment]
+
+        if env_config.is_a?(String)
+          # Support this for now to be passive but we will remove it later
+          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
+        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']
+        else
+          raise "Unexepcted value for environment [#{environment}] config. Expected String or Hash, saw #{config['environments'][environment]}"
+        end
 
         # Convert namespace config hash to hash with symbols for keys
         namespace_config = config['namespace'].each_with_object({}) { |(k, v), memo| memo[k.to_sym] = v; }

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

@@ -42,7 +42,7 @@ module Splunk
       def alert_defaults
         {
           # Who to email
-          'action.email.to' => pickaxe_config.config['emails'].join(','),
+          'action.email.to' => pickaxe_config.emails.join(','),
 
           # How often to run alert (every hour)
           'cron_schedule' => '0 * * * *',

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

@@ -41,7 +41,7 @@ module Splunk
       def report_defaults
         {
           # Who to email
-          'action.email.to' => pickaxe_config.config['emails'].join(','),
+          'action.email.to' => pickaxe_config.emails.join(','),
 
           # How often to run alert (every hour)
           'cron_schedule' => '0 * * * *',

data/lib/splunk/pickaxe/version.rb

@@ -2,6 +2,6 @@
 
 module Splunk
   module Pickaxe
-    VERSION = '2.2.0'
+    VERSION = '2.3.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: splunk-pickaxe
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Bryan Baugher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-11 00:00:00.000000000 Z
+date: 2018-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: splunk-sdk-ruby