sensu-plugins-kubernetes-reactiveops 0.1.0

data/bin/handler-kube-pod.rb

@@ -0,0 +1,87 @@
+#! /usr/bin/env ruby
+#
+#   handler-kube-pod
+#
+# DESCRIPTION:
+# => Deletes pods from the k8s cluster and sensu, intended to be used as a
+#    keepalive handler.
+#
+# OUTPUT:
+#   plain text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: kube-client
+#
+# USAGE:
+# -j JSONCONFIG - The settings section to use
+#
+# NOTES:
+#
+# LICENSE:
+#   Justin McCarty <jmccarty3@gmail.com>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-handler'
+require 'sensu-plugins-kubernetes/client'
+
+class KubePod < Sensu::Handler
+  include Sensu::Plugins::Kubernetes::Client
+
+  option :json_config,
+         description: 'Configuration section name',
+         short: '-j JSONCONFIG',
+         long: '--json JSONCONFIG',
+         default: 'k8s'
+
+  def client_config
+    defaults = {
+      server: ENV['KUBERNETES_MASTER'],
+      version: 'v1'
+    }
+    h = settings[config[:json_config]]
+    if h.is_a?(Hash)
+      # Maintain backwards compatibility
+      h[:server] ||= h[:api_server]
+      h[:version] ||= h[:api_version]
+      # And merge
+      defaults.merge!(h)
+    else
+      defaults
+    end
+  end
+
+  def handle
+    puts 'K8 handler'
+    response = api_request(:DELETE, '/clients/' + @event['client']['name']).code
+    deletion_status(response)
+    begin
+      client = kubeclient(client_config)
+      client.delete_pod @event['client']['name']
+    rescue ArgumentError => e
+      puts "[Kube Pod] Invalid settings: #{e.message}"
+    rescue KubeException => e
+      puts "[Kube Pod] KubeException: #{e.message}"
+    rescue Exception => e # rubocop:disable Lint/RescueException
+      puts "[Kube Pod] Unknown error #{e}"
+    end
+  end
+
+  def deletion_status(code)
+    case code
+    when '202'
+      puts "[Kube Pod] 202: Successfully deleted Sensu client: #{@event['client']['name']}"
+    when '404'
+      puts "[Kube Pod] 404: Unable to delete #{@event['client']['name']}, doesn't exist!"
+    when '500'
+      puts "[Kube Pod] 500: Miscellaneous error when deleting #{@event['client']['name']}"
+    else
+      puts "[Kube Pod] #{code}: Completely unsure of what happened!"
+    end
+  end
+end

data/bin/metrics-pods.rb

@@ -0,0 +1,59 @@
+#! /usr/bin/env ruby
+#
+#   pod-metrics
+#
+# DESCRIPTION:
+#   Will give pod counts from all the exposed services
+#
+# OUTPUT:
+#   metric data
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: kube-client
+#
+# USAGE:
+#
+# NOTES:
+#
+# LICENSE:
+#   Copyright 2016 Chris McFee <cmcfee@kent.edu>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+require 'sensu-plugins-kubernetes/cli'
+require 'sensu-plugin/metric/cli'
+require 'uri'
+
+class PodsMetrics < Sensu::Plugin::Metric::CLI::Graphite
+  @options = Sensu::Plugins::Kubernetes::CLI.options.dup
+
+  def run
+    config[:scheme] = "#{URI(config[:api_server]).host}.pods"
+    count = {}
+    client = Sensu::Plugins::Kubernetes::CLI.new.client
+    services = client.get_services
+    services.each do |s|
+      selector_key = []
+      count[s.metadata.name] = 0
+      services.delete(s.metadata.name)
+      s.spec.selector.to_h.each do |k, v|
+        selector_key << "#{k}=#{v}"
+      end
+      pod = nil
+      begin
+        pod = client.get_pods(label_selector: selector_key.join(',').to_s)
+      rescue KubeException => e
+        critical 'API error: ' << e.message
+      end
+      next if pod.nil?
+      pod.each do
+        count[s.metadata.name] += 1
+      end
+    end
+    count.each { |k, v| output "#{config[:scheme]}.#{k}", v }
+    ok
+  end
+end

data/lib/sensu-plugins-kubernetes.rb

@@ -0,0 +1 @@
+require 'sensu-plugins-kubernetes/version'

data/lib/sensu-plugins-kubernetes/cli.rb

@@ -0,0 +1,96 @@
+require 'sensu-plugin/check/cli'
+require 'sensu-plugins-kubernetes/client.rb'
+
+module Sensu
+  module Plugins
+    # Namespace for the Kubernetes sensu-plugin.
+    module Kubernetes
+      # Abstract base class for a Sensu check that also provides
+      # Kubernetes client connection support.
+      class CLI < Sensu::Plugin::Check::CLI
+        include Sensu::Plugins::Kubernetes::Client
+
+        option :api_server,
+               description: 'URL to API server',
+               short: '-s URL',
+               long: '--api-server',
+               default: ENV['KUBERNETES_MASTER']
+
+        option :api_version,
+               description: 'API version',
+               short: '-v VERSION',
+               long: '--api-version',
+               default: 'v1'
+
+        option :api_incluster,
+               description: 'Use service account authentication',
+               long: '--in-cluster',
+               boolean: true,
+               default: false
+
+        option :api_ca_file,
+               description: 'CA file to verify API server cert',
+               long: '--ca-file CA-FILE',
+               default: nil
+
+        option :api_client_cert,
+               description: 'Client cert to present',
+               long: '--cert CERT-FILE',
+               default: nil
+
+        option :api_client_key,
+               description: 'Client key for the client cert',
+               long: '--key KEY-FILE',
+               default: nil
+
+        option :api_user,
+               description: 'User with access to API',
+               short: '-u USER',
+               long: '--user',
+               default: nil
+
+        option :api_password,
+               description: 'If user is passed, also pass a password',
+               short: '-p PASSWORD',
+               long: '--password',
+               default: nil
+
+        option :api_token,
+               description: 'Bearer token for authorization',
+               short: '-t TOKEN',
+               long: '--token',
+               default: nil
+
+        option :api_token_file,
+               description: 'File containing bearer token for authorization',
+               long: '--token-file TOKEN-FILE',
+               default: nil
+
+        attr_reader :client
+
+        # Initializes the Sensu check by creating a Kubernetes client
+        # from the given options and will report a critical error if
+        # those arguments are incorrect.
+        def initialize
+          super()
+          begin
+            @client = kubeclient(
+              server: config[:api_server],
+              version: config[:api_version],
+              incluster: config[:api_incluster],
+              ca_file: config[:api_ca_file],
+              client_cert_file: config[:api_client_cert],
+              client_key_file: config[:api_client_key],
+              username: config[:api_user],
+              password: config[:api_password],
+              token: config[:api_token],
+              token_file: config[:api_token_file]
+            )
+          rescue ArgumentError => e
+            critical e.message
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sensu-plugins-kubernetes/client.rb

@@ -0,0 +1,126 @@
+require 'kubeclient'
+require 'uri'
+
+module Sensu
+  module Plugins
+    # Namespace for the Kubernetes sensu-plugin.
+    module Kubernetes
+      # A mixin module that provides Kubernetes client (kubeclient) support.
+      module Client
+        # The location of the service account provided CA.
+        # (if the cluster is configured to provide it)
+        INCLUSTER_CA_FILE =
+          '/var/run/secrets/kubernetes.io/serviceaccount/ca.crt'.freeze
+
+        # The location of the service account provided authentication token.
+        INCLUSTER_TOKEN_FILE =
+          '/var/run/secrets/kubernetes.io/serviceaccount/token'.freeze
+
+        # Creates a new Kubeclient::Client instance using the given SSL
+        # and authentication options (if any)
+        #
+        # @param [Hash] options The Kubernetes API connection details.
+        # @option options [String] :server URL to API server
+        # @option options [String] :version API version
+        # @option options [Boolean] :incluster
+        #   Use service account authentication if true
+        # @option options [String] :ca_file
+        #   CA file used to verify API server certificate
+        # @option options [String] :client_cert_file
+        #   Client certificate file to present
+        # @option options [String] :client_key_file
+        #   Client private key file for the client certificate
+        # @option options [String] :username
+        #   Username with access to API
+        # @option options [String] :password
+        #   If a username is passed, also pass a password
+        # @option options [String] :token
+        #   The bearer token for Kubernetes authorization
+        # @option options [String] :token_file
+        #   A file containing the bearer token for Kubernetes authorization
+        #
+        # @raise [ArgumentError] If an invalid option, or combination of options, is given.
+        # @raise [Errono::*] If there is a problem reading the client certificate or private key file.
+        # @raise [OpenSSL::X509::CertificateError] If there is a problem with the client certificate.
+        # @raise [OpenSSL::PKey::RSAError] If there is a problem with the client private key.
+        def kubeclient(options = {})
+          raise(ArgumentError, 'options must be a hash') unless options.is_a?(Hash)
+
+          api_server = options[:server]
+          api_version = options[:version]
+
+          ssl_options = {
+            ca_file: options[:ca_file]
+          }
+          auth_options = {
+            username: options[:username],
+            password: options[:password],
+            bearer_token: options[:token],
+            bearer_token_file: options[:token_file]
+          }
+
+          if [:client_cert_file, :client_key_file].count { |k| options[k] } == 1
+            raise ArgumentError, 'SSL requires both client cert and client key'
+          end
+
+          if options[:client_cert_file]
+            begin
+              ssl_options[:client_cert] = OpenSSL::X509::Certificate.new(File.read(options[:client_cert_file]))
+            rescue => e
+              raise e, "Unable to read client certificate: #{e}", e.backtrace
+            end
+          end
+
+          if options[:client_key_file]
+            begin
+              ssl_options[:client_key] = OpenSSL::PKey::RSA.new(File.read(options[:client_key_file]))
+            rescue => e
+              raise e, "Unable to read client key: #{e}", e.backtrace
+            end
+          end
+
+          if options[:incluster]
+            # Provide in-cluster defaults, if not already specified
+            # (following the kubernetes incluster config code, more or less)
+
+            # api-server
+            # TODO: use in-cluster DNS ??
+            if api_server.nil?
+              host = ENV['KUBERNETES_SERVICE_HOST']
+              port = ENV['KUBERNETES_SERVICE_PORT']
+              if host.nil? || port.nil?
+                raise ArgumentError, 'unable to load in-cluster configuration,'\
+                     ' KUBERNETES_SERVICE_HOST and KUBERNETES_SERVICE_PORT'\
+                     ' must be defined'
+              end
+              api_server = URI::HTTPS.build(host: host, port: port, path: '/api')
+            end
+
+            # ca file, but only if it exists
+            if ssl_options[:ca_file].nil? && File.exist?(INCLUSTER_CA_FILE)
+              # Readability/permission issues should be left to kubeclient
+              ssl_options[:ca_file] = INCLUSTER_CA_FILE
+            end
+
+            # token file
+            if auth_options[:bearer_token_file].nil?
+              auth_options[:bearer_token_file] = INCLUSTER_TOKEN_FILE
+            end
+          end
+
+          ssl_options[:verify_ssl] = ssl_options[:ca_file] ? OpenSSL::SSL::VERIFY_PEER : OpenSSL::SSL::VERIFY_NONE
+
+          begin
+            # new only throws errors on bad arguments
+            Kubeclient::Client.new(api_server, api_version,
+                                   ssl_options: ssl_options,
+                                   auth_options: auth_options)
+          rescue URI::InvalidURIError => e
+            # except for this one, which we'll re-wrap to make catching easier
+            raise ArgumentError, "Invalid API server: #{e}", e.backtrace
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sensu-plugins-kubernetes/version.rb

@@ -0,0 +1,9 @@
+module SensuPluginsKubernetes
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 2
+
+    VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
+  end
+end

metadata

@@ -0,0 +1,242 @@
+--- !ruby/object:Gem::Specification
+name: sensu-plugins-kubernetes-reactiveops
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sensu-Plugins and contributors
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sensu-plugin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: kubeclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.40.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.40.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Provides monitoring for Kubernetes via Sensu
+email: "<sensu-users@googlegroups.com>"
+executables:
+- check-kube-apiserver-available.rb
+- check-kube-nodes-ready.rb
+- check-kube-pods-pending.rb
+- check-kube-pods-restarting.rb
+- check-kube-pods-running.rb
+- check-kube-pods-runtime.rb
+- check-kube-service-available.rb
+- handler-kube-pod.rb
+- metrics-pods.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/check-kube-apiserver-available.rb
+- bin/check-kube-nodes-ready.rb
+- bin/check-kube-pods-pending.rb
+- bin/check-kube-pods-restarting.rb
+- bin/check-kube-pods-running.rb
+- bin/check-kube-pods-runtime.rb
+- bin/check-kube-service-available.rb
+- bin/handler-kube-pod.rb
+- bin/metrics-pods.rb
+- lib/sensu-plugins-kubernetes.rb
+- lib/sensu-plugins-kubernetes/cli.rb
+- lib/sensu-plugins-kubernetes/client.rb
+- lib/sensu-plugins-kubernetes/version.rb
+homepage: https://github.com/reactiveops/sensu-plugins-kubernetes
+licenses:
+- MIT
+metadata:
+  maintainer: reactiveops
+  development_status: active
+  production_status: unstable - testing recommended
+  release_draft: 'false'
+  release_prerelease: 'false'
+post_install_message: You can use the embedded Ruby by setting EMBEDDED_RUBY=true
+  in /etc/default/sensu
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Sensu plugins for kubernetes
+test_files: []