sensu-translator 0.3.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bd368436b5cde39a6ec79e55818d3ac5762b343e
-  data.tar.gz: 843998e143b6968e22da0f23682d59bf40db76d5
+SHA256:
+  metadata.gz: 650c8cdfabbe7a3c6f8fd224a4655d6ff6208e8e1e6ada2f2b01e6223883cc9e
+  data.tar.gz: af0978bded782e6c6cc0c52cd86efb5cfadaa5f3592e7ca9e988105c553d05af
 SHA512:
-  metadata.gz: 98673f38e12abebbcc9918e3549a1e4fa8351cf8e7a9a4c930b43afa02663c768abbec8625e92494d4d9d87048f8eb6c93482f343cf66bd9bf75876554b60f1d
-  data.tar.gz: 68a3a06cccd948fa5feb1aebb134db99fab44cfcd81bd6681c792ee0c087514cc1d0a2b3bc7567d3ef07f16ea80dc14f22a1dd90baf0dd570af00c456f2d5016
+  metadata.gz: d3210d02ec78544877a61f2d34128942dae1934056a0c80e0de064891e7342b3a5d5376ee7ae794140dc6901e9ec3dc4e250d2e2049416de2aba00bd07173b49
+  data.tar.gz: 1514ebcfc57391505e1365a9bf1dd7f9467e676171b1d2b16099d942e9a73fc36001ceac9fd5347454057e6352ed18857981ef80a67226904f99ee508340bc1d

data/.gitignore

@@ -7,6 +7,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+vendor/
 
 # rspec failure tracking
 .rspec_status

data/CHANGELOG.md

@@ -6,6 +6,40 @@ This CHANGELOG follows the format listed [here](https://github.com/sensu-plugins
 
 ## [Unreleased]
 
+## [1.2.0] - 2021-03-10
+### Added
+- Translate check pager_team to the pagerduty plugin config team annotation
+
+## [1.1.0] - 2020-02-19
+### Added
+- Translate check occurrences and refresh to fatigue_check annotations
+
+## [1.0.1] - 2018-12-18
+
+### Fixed
+- Now getting Sensu Go config file name from object metadata
+- Check timeout no longer treated as custom
+- Unable to translate log lines now include object inspection
+
+## [1.0.0] - 2018-12-04
+
+### Changed
+- Now using an annotation for json_attributes instead of a label
+- Namespaced the json_attributes annotation, sensu.io.*
+
+### Added
+- Custom attributes added to Go label "json_attributes"
+
+## [0.4.0] - 2018-11-29
+
+### Changed
+- Renamed Sensu 2.x -> Sensu Go
+- Replaced Organization/Environment with Namespace
+- Sensu Go configuration object files now include mandatory metadata
+
+### Added
+- Custom attributes added to Go label "json_attributes"
+
 ## [0.3.0] - 2018-05-04
 
 ### Fixed

data/README.md

@@ -19,9 +19,8 @@ Usage: sensu-translator [options]
     -V, --version                    Display version
     -c, --config FILE                Sensu 1.x JSON config FILE. Default: /etc/sensu/config.json (if exists)
     -d, --config_dir DIR[,DIR]       DIR or comma-delimited DIR list for Sensu 1.x JSON config files. Default: /etc/sensu/conf.d (if exists)
-    -o, --output_dir DIR             Sensu 2.0 config output DIR. Default: /tmp/sensu_v2
-    -O, --organization ORG           Sensu 2.0 RBAC Organization. Default: default
-    -E, --environment ENV            Sensu 2.0 RBAC Environment. Default: default
+    -o, --output_dir DIR             Sensu Go config output DIR. Default: /tmp/sensu_go
+    -n, --namespace NAMESPACE        Sensu Go Namespace. Default: default
 ```
 
 ## Example
@@ -29,11 +28,11 @@ Usage: sensu-translator [options]
 1. Translate Sensu 1.x configuration into the Sensu 2.x format
 
 ```
-$ sensu-translator -c /etc/sensu/config.json -d /etc/sensu/conf.d -o /tmp/sensu_v2
+$ sensu-translator -c /etc/sensu/config.json -d /etc/sensu/conf.d -o /tmp/sensu_go
 
-$ tree /tmp/sensu_v2
+$ tree /tmp/sensu_go
 
-/tmp/sensu_v2
+/tmp/sensu_go
 ├── checks
 │   ├── website-healthz.json
 │   └── haproxy-backends.json
@@ -50,7 +49,7 @@ $ tree /tmp/sensu_v2
 2. Use a configured `sensuctl` and the newly created 2.x configuration files to manage Sensu 2.x resources
 
 ```
-sensuctl create -f /tmp/sensu_v2/checks/website-healthz.json
+sensuctl create -f /tmp/sensu_go/checks/website-healthz.json
 ```
 
 ## Development

data/lib/sensu/translator.rb

@@ -27,28 +27,27 @@ module Sensu
       end
 
       def translate(v1_settings)
-        v2_resources = []
+        go_resources = []
         Sensu::Settings::CATEGORIES.each do |category|
           method_name = "translate_#{category.to_s.chop}"
-          v1_settings[category].each do |name, settings|
-            object = {:name => name.to_s}.merge(settings)
-            v2_resources << send(method_name, object, @options[:organization], @options[:environment])
+          v1_settings[category].each do |name, object|
+            go_resources << send(method_name, object, @options[:namespace], name)
           end
         end
-        v2_resources.compact
+        go_resources.compact
       end
 
-      def create_v2_output_files!(v2_resources)
+      def create_go_output_files!(go_resources)
         output_dir = @options[:output_dir]
         Sensu::Settings::CATEGORIES.each do |category|
           category_dir = File.join(output_dir, category.to_s)
           FileUtils.mkdir_p(category_dir)
         end
-        v2_resources.each do |v2_resource|
-          category = "#{v2_resource[:type].downcase}s"
-          file_name = "#{v2_resource[:spec][:name]}.json"
+        go_resources.each do |go_resource|
+          category = "#{go_resource[:type].downcase}s"
+          file_name = "#{go_resource[:metadata][:name]}.json"
           output_file = File.join(output_dir, category, file_name)
-          content = Sensu::JSON.dump(v2_resource, :pretty => true)
+          content = Sensu::JSON.dump(go_resource, :pretty => true)
           File.open(output_file, "w") do |file|
             file.write(content)
           end
@@ -57,8 +56,8 @@ module Sensu
 
       def run
         v1_settings = load_v1_settings
-        v2_resources = translate(v1_settings)
-        create_v2_output_files!(v2_resources)
+        go_resources = translate(v1_settings)
+        create_go_output_files!(go_resources)
         puts "DONE!"
       end
     end

data/lib/sensu/translator/cli.rb

@@ -12,9 +12,8 @@ module Sensu
       # @return [Hash] options
       def self.read(arguments=ARGV)
         options = {
-          :output_dir => "/tmp/sensu_v2",
-          :organization => "default",
-          :environment => "default"
+          :output_dir => "/tmp/sensu_go",
+          :namespace => "default"
         }
         if File.exist?("/etc/sensu/config.json")
           options[:config_file] = "/etc/sensu/config.json"
@@ -37,14 +36,11 @@ module Sensu
           opts.on("-d", "--config_dir DIR[,DIR]", "DIR or comma-delimited DIR list for Sensu 1.x JSON config files. Default: /etc/sensu/conf.d (if exists)") do |dir|
             options[:config_dirs] = dir.split(",")
           end
-          opts.on("-o", "--output_dir DIR", "Sensu 2.0 config output DIR. Default: /tmp/sensu_v2") do |dir|
+          opts.on("-o", "--output_dir DIR", "Sensu 2.0 config output DIR. Default: /tmp/sensu_go") do |dir|
             options[:output_dir] = dir
           end
-          opts.on("-O", "--organization ORG", "Sensu 2.0 RBAC Organization. Default: default") do |org|
-            options[:organization] = org
-          end
-          opts.on("-E", "--environment ENV", "Sensu 2.0 RBAC Environment. Default: default") do |env|
-            options[:environment] = env
+          opts.on("-n", "--namespace NAMESPACE", "Sensu 2.0 Namespace. Default: default") do |namespace|
+            options[:namespace] = namespace
           end
         end
         optparse.parse!(arguments)

data/lib/sensu/translator/translations.rb

@@ -1,44 +1,72 @@
 module Sensu
   module Translator
     module Translations
-      def v2_spec(type, object, organization, environment)
+      def go_spec(type, spec, namespace, name, labels={}, annotations={})
+        metadata = {
+          :namespace => namespace,
+          :name => name,
+          :labels => labels,
+          :annotations => annotations
+        }
         {
+          :api_version => "core/v2",
           :type => type.to_s.capitalize,
-          :spec => object.merge(:organization => organization, :environment => environment)
+          :metadata => metadata,
+          :spec => spec
         }
       end
 
-      def translate_check(check, organization, environment)
-        check[:subscriptions] = check.delete(:subscribers) || []
-        if check[:standalone]
-          check.delete(:standalone)
-          check[:subscriptions] << "standalone"
+      def translate_check(object, namespace, name)
+        check = {}
+        check[:command] = object.delete(:command)
+        if object[:standalone]
+          object.delete(:standalone)
+          check[:subscriptions] = ["standalone"]
+        else
+          check[:subscriptions] = object.delete(:subscribers) || []
         end
-        check[:publish] = check.fetch(:publish, true)
-        check[:handlers] ||= [check.fetch(:handler, "default")]
-        if check[:source]
-          check[:proxy_entity_id] = check.delete(:source)
+        publish = object.delete(:publish)
+        publish = true if publish.nil?
+        check[:publish] = publish
+        check[:interval] = object.delete(:interval) if object[:interval]
+        check[:cron] = object.delete(:cron) if object[:cron]
+        check[:handlers] = object.delete(:handlers) || ["default"]
+        check[:handlers] << object.delete(:handler) if object[:handler]
+        check[:handlers].uniq!
+        check[:proxy_entity_name] = object.delete(:source) if object[:source]
+        check[:stdin] = object.delete(:stdin) if object[:stdin]
+        check[:timeout] = object.delete(:timeout) if object[:timeout]
+        check[:ttl] = object.delete(:ttl) if object[:ttl]
+        check[:low_flap_threshold] = object.delete(:low_flap_threshold) if object[:low_flap_threshold]
+        check[:high_flap_threshold] = object.delete(:high_flap_threshold) if object[:high_flap_threshold]
+        # TODO: subdue, hooks
+        annotations = {}
+        unless object.empty?
+          annotations["sensu.io.json_attributes".to_sym] = Sensu::JSON.dump(object)
         end
-        v2_spec(:check, check, organization, environment)
+        annotations["fatigue_check/occurrences"] = object[:occurrences].to_s if object[:occurrences]
+        annotations["fatigue_check/interval"] = object[:refresh].to_s if object[:refresh]
+        annotations["sensu.io/plugins/sensu-pagerduty-handler/config/team"] = object[:pager_team].to_s if object[:pager_team]
+        go_spec(:check, check, namespace, name, {}, annotations)
       end
 
-      def translate_filter(filter, organization, environment)
+      def translate_filter(object, namespace, name)
         puts "Sensu 1.x filter translation is not yet supported"
-        puts "Unable to translate Sensu 1.x filter: #{filter}"
+        puts "Unable to translate Sensu 1.x filter: #{name} #{object}"
         nil
       end
 
-      def translate_mutator(mutator, organization, environment)
-        v2_spec(:mutator, mutator, organization, environment)
+      def translate_mutator(object, namespace, name)
+        go_spec(:mutator, object, namespace, name)
       end
 
-      def translate_handler(handler, organization, environment)
-        v2_spec(:handler, handler, organization, environment)
+      def translate_handler(object, namespace, name)
+        go_spec(:handler, object, namespace, name)
       end
 
-      def translate_extension(extension, organization, environment)
+      def translate_extension(object, namespace, name)
         puts "Sensu 1.x extension translation is not yet supported"
-        puts "Unable to translate Sensu 1.x extension: #{extension}"
+        puts "Unable to translate Sensu 1.x extension: #{name} - #{object}"
         nil
       end
     end

data/lib/sensu/translator/version.rb

@@ -1,5 +1,5 @@
 module Sensu
   module Translator
-    VERSION = "0.3.0"
+    VERSION = "1.2.0"
   end
 end

data/sensu-translator.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "sensu-json", ">= 2.1.1"
   spec.add_dependency "sensu-settings", ">= 10.13.1"
 
-  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sensu-translator
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Sean Porter
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-04 00:00:00.000000000 Z
+date: 2021-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-json
@@ -43,16 +43,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -125,8 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A tool for translating Sensu 1.x config to the Sensu 2.x format.