sensu-plugins-kubernetes 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e7891019bcd4d1ee4a9ee93933dfe027e4059a3b
-  data.tar.gz: 6a530b4917597e3b2aede0e3deeb709a25a9a5bd
+  metadata.gz: da62b54a627d8cb692fc340e5e004d31f4c836cf
+  data.tar.gz: ffa06f5b83a3e6539a9934929354dc2658873ae3
 SHA512:
-  metadata.gz: 6bfc0e8b53232cbc19061ad115964f8592a1e05be418281ff18e340d74635353a1692f8f2a2c625b17296531d7be4a87271ed98292e9957bef8641e7e0e4484e
-  data.tar.gz: 4a526bc45fcae03e58dd26def4c88dca48331286a87f10836a08aee5f6bfbb6d02959bb241f0945bda4b0e6348b6bfe32808c45aab3fed761af9dac65f0a192b
+  metadata.gz: d1652721603c4ca51d28f1fdb4248b189c0535722902f8355480cfd1f91f2d7e6761a31c278e5d39db1fff78b42e9ccd183eeb164744d371331bb1fb59df825d
+  data.tar.gz: 26b2e69ce1a96ccff4f9bb053e65476d7fe1984e48e83d79b53022d83679c7af14a36ead9aec3194311420f891dc0b35c3880ead9c7ad95a1d35e7cb7548869a

data/CHANGELOG.md

@@ -1,10 +1,20 @@
-#Change Log
+# Change Log
 This project adheres to [Semantic Versioning](http://semver.org/).
 
 This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
 
 ## [Unreleased]
 
+## [1.0.0] - 2017-03-21
+### Added
+- Add `metrics-pods.rb` that will output the number of running pods per service (@mickfeech)
+- Add `check-kube-pods-running` check (@nyxcharon)
+
+### Changed
+- Update `kubeclient` to 2.3.0 (@jackfengji)
+- Split `check-kube-pods-pending` into two checks; the original still checks for
+pending pods, the restart count portion has been split into it's own check, `check-kube-pods-restarting`. (@nyxcharon)
+
 ## [0.1.2] - 2016-08-07
 ### Fixed
 - check-kube-service-available.rb: fixed error caused by misspelling of true boolean (@justinhammar)
@@ -39,7 +49,8 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 ### Added
 - initial release
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-kubernetes/compare/0.1.2...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-kubernetes/compare/1.0.0...HEAD
+[1.0.0]: https://github.com/sensu-plugins/sensu-plugins-kubernetes/compare/0.1.2...1.0.0
 [0.1.2]: https://github.com/sensu-plugins/sensu-plugins-kubernetes/compare/0.1.1...0.1.2
 [0.1.1]: https://github.com/sensu-plugins/sensu-plugins-kubernetes/compare/0.1.0...0.1.1
 [0.1.0]: https://github.com/sensu-plugins/sensu-plugins-kubernetes/compare/0.0.1...0.1.0

data/README.md

@@ -15,7 +15,10 @@ This provides functionality to check node and pod status as well as api and serv
 - bin/check-kube-pods-pending.rb
 - bin/check-kube-service-available.rb
 - bin/check-kube-pods-runtime.rb
+- bin/check-kube-pods-running.rb
+- bin/check-kube-pods-restarting.rb
 - bin/handler-kube-pod.rb
+- bin/metrics-pods.rb
 
 ## Usage
 
@@ -105,6 +108,46 @@ Usage: check-kube-pods-runtime.rb (options)
     -w, --warn TIMEOUT               Threshold for pods to be in the pending state
 ```
 
+**check-kube-pods-running.rb**
+```
+Usage: ./check-kube-pods-running.rb (options)
+        --ca-file CA-FILE            CA file to verify API server cert
+        --cert CERT-FILE             Client cert to present
+        --key KEY-FILE               Client key for the client cert
+        --in-cluster                 Use service account authentication
+        --password PASSWORD          If user is passed, also pass a password
+    -s, --api-server URL             URL to API server
+    -t, --token TOKEN                Bearer token for authorization
+        --token-file TOKEN-FILE      File containing bearer token for authorization
+    -u, --user USER                  User with access to API
+    -v, --api-version VERSION        API version
+    -n NAMESPACES,                   Exclude the specified list of namespaces
+        --exclude-namespace
+    -f, --filter FILTER              Selector filter for pods to be checked
+    -p, --pods PODS                  List of pods to check
+```
+
+**check-kube-pods-restarting.rb**
+
+```
+Usage: ./check-kube-pods-restarting.rb (options)
+        --ca-file CA-FILE            CA file to verify API server cert
+        --cert CERT-FILE             Client cert to present
+        --key KEY-FILE               Client key for the client cert
+        --in-cluster                 Use service account authentication
+        --password PASSWORD          If user is passed, also pass a password
+    -s, --api-server URL             URL to API server
+    -t, --token TOKEN                Bearer token for authorization
+        --token-file TOKEN-FILE      File containing bearer token for authorization
+    -u, --user USER                  User with access to API
+    -v, --api-version VERSION        API version
+    -n NAMESPACES,                   Exclude the specified list of namespaces
+        --exclude-namespace
+    -f, --filter FILTER              Selector filter for pods to be checked
+    -p, --pods PODS                  List of pods to check
+    -r, --restart COUNT              Threshold for number of restarts allowed
+```
+
 **handler-kube-pod.rb**
 ```
 Usage: handler-kube-pod.rb (options)
@@ -130,6 +173,21 @@ Usage: handler-kube-pod.rb (options)
 }
 ```
 
+**metrics-pods**
+```
+Usage: metrics-pods.rb (options)
+        --ca-file CA-FILE            CA file to verify API server cert
+        --cert CERT-FILE             Client cert to present
+        --key KEY-FILE               Client key for the client cert
+        --in-cluster                 Use service account authentication
+        --password PASSWORD          If user is passed, also pass a password
+        -s, --api-server URL             URL to API server
+        -t, --token TOKEN                Bearer token for authorization
+        --token-file TOKEN-FILE      File containing bearer token for authorization
+        -u, --user USER                  User with access to API
+        -v, --api-version VERSION        API version
+```
+
 `api_server` and `api_version` can still be used for backwards compatibility,
 but `server` and `version` will take precedence.
 

data/bin/check-kube-pods-pending.rb

@@ -32,7 +32,6 @@
 # -f, --filter FILTER              Selector filter for pods to be checked
 # -p, --pods PODS                  Optional list of pods to check.
 #                                  Defaults to 'all'
-# -r, --restart COUNT              Threshold for number of restarts allowed
 #
 # NOTES:
 # => The filter used for the -f flag is in the form key=value. If multiple
@@ -62,13 +61,6 @@ class AllPodsAreReady < Sensu::Plugins::Kubernetes::CLI
          proc: proc(&:to_i),
          default: 300
 
-  option :restart_count,
-         description: 'Threshold for number of restarts allowed',
-         short: '-r COUNT',
-         long: '--restart',
-         proc: proc(&:to_i),
-         default: 10
-
   option :pod_filter,
          description: 'Selector filter for pods to be checked',
          short: '-f FILTER',
@@ -84,7 +76,6 @@ class AllPodsAreReady < Sensu::Plugins::Kubernetes::CLI
   def run
     pods_list = []
     failed_pods = []
-    restarted_pods = []
     pods = []
     if config[:pod_filter].nil?
       pods_list = parse_list(config[:pod_list])
@@ -101,29 +92,17 @@ class AllPodsAreReady < Sensu::Plugins::Kubernetes::CLI
       next if config[:exclude_namespace].include?(pod.metadata.namespace)
       next unless pods_list.include?(pod.metadata.name) || pods_list.include?('all')
       # Check for pending state
-      if pod.status.phase == 'Pending'
-        pod_stamp = Time.parse(pod.metadata.creationTimestamp)
-        if (Time.now.utc - pod_stamp.utc).to_i > config[:pending_timeout]
-          failed_pods << "#{pod.metadata.namespace}.#{pod.metadata.name}"
-        end
-      end
-      # Check restarts
-      next if pod.status.containerStatuses.nil?
-      pod.status.containerStatuses.each do |container|
-        if container.restartCount.to_i > config[:restart_count]
-          restarted_pods << "#{pod.metadata.namespace}.#{container.name}"
-        end
+      next unless pod.status.phase == 'Pending'
+      pod_stamp = Time.parse(pod.metadata.creationTimestamp)
+      puts pod.metadata.name
+      if (Time.now.utc - pod_stamp.utc).to_i > config[:pending_timeout]
+        failed_pods << "#{pod.metadata.namespace}.#{pod.metadata.name}"
       end
     end
-
-    if failed_pods.empty? && restarted_pods.empty?
+    if failed_pods.empty?
       ok 'All pods are reporting as ready'
-    elsif failed_pods.empty?
-      critical "Pods exceeded restart threshold: #{restarted_pods.join(' ')}"
-    elsif restarted_pods.empty?
-      critical "Pods exceeded pending threshold: #{failed_pods.join(' ')}"
     else
-      critical "Pod restart and pending thresholds exceeded, pending: #{failed_pods.join(' ')} restarting: #{restarted_pods.join(' ')}"
+      critical "Pods exceeded pending threshold: #{failed_pods.join(' ')}"
     end
   rescue KubeException => e
     critical 'API error: ' << e.message

data/bin/check-kube-pods-restarting.rb

@@ -0,0 +1,116 @@
+#! /usr/bin/env ruby
+#
+#   check-kube-pods-restarting
+#
+# DESCRIPTION:
+# => Check if pods are constantly restarting
+#
+# OUTPUT:
+#   plain text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: kube-client
+#
+# USAGE:
+# --ca-file CA-FILE            CA file to verify API server cert
+#        --cert CERT-FILE             Client cert to present
+#        --key KEY-FILE               Client key for the client cert
+#        --in-cluster                 Use service account authentication
+#        --password PASSWORD          If user is passed, also pass a password
+#    -s, --api-server URL             URL to API server
+#    -t, --token TOKEN                Bearer token for authorization
+#        --token-file TOKEN-FILE      File containing bearer token for authorization
+#    -u, --user USER                  User with access to API
+#    -v, --api-version VERSION        API version
+#    -n NAMESPACES,                   Exclude the specified list of namespaces
+#        --exclude-namespace
+#    -f, --filter FILTER              Selector filter for pods to be checked
+#    -p, --pods PODS                  List of pods to check
+#    -r, --restart COUNT              Threshold for number of restarts allowed
+#
+# NOTES:
+# => The filter used for the -f flag is in the form key=value. If multiple
+#    filters need to be specfied, use a comma. ex. foo=bar,red=color
+#
+# LICENSE:
+#   Barry Martin <nyxcharon@gmail.com>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugins-kubernetes/cli'
+
+class PodsRestarting < Sensu::Plugins::Kubernetes::CLI
+  @options = Sensu::Plugins::Kubernetes::CLI.options.dup
+
+  option :pod_list,
+         description: 'List of pods to check',
+         short: '-p PODS',
+         long: '--pods',
+         default: 'all'
+
+  option :restart_count,
+         description: 'Threshold for number of restarts allowed',
+         short: '-r COUNT',
+         long: '--restart',
+         proc: proc(&:to_i),
+         default: 10
+
+  option :pod_filter,
+         description: 'Selector filter for pods to be checked',
+         short: '-f FILTER',
+         long: '--filter'
+
+  option :exclude_namespace,
+         description: 'Exclude the specified list of namespaces',
+         short: '-n NAMESPACES',
+         long: '--exclude-namespace',
+         proc: proc { |a| a.split(',') },
+         default: ''
+
+  def run
+    pods_list = []
+    restarted_pods = []
+    pods = []
+    if config[:pod_filter].nil?
+      pods_list = parse_list(config[:pod_list])
+      pods = client.get_pods
+    else
+      pods = client.get_pods(label_selector: config[:pod_filter].to_s)
+      if pods.empty?
+        unknown 'The filter specified resulted in 0 pods'
+      end
+      pods_list = ['all']
+    end
+    pods.each do |pod|
+      next if pod.nil?
+      next if config[:exclude_namespace].include?(pod.metadata.namespace)
+      next unless pods_list.include?(pod.metadata.name) || pods_list.include?('all')
+      # Check restarts
+      next if pod.status.containerStatuses.nil?
+      pod.status.containerStatuses.each do |container|
+        if container.restartCount.to_i > config[:restart_count]
+          restarted_pods << "#{pod.metadata.namespace}.#{container.name}"
+        end
+      end
+    end
+
+    if restarted_pods.empty?
+      ok 'All pods are under restart threshold'
+    else
+      critical "Pods exceeded restart threshold: #{restarted_pods.join(' ')}"
+    end
+  rescue KubeException => e
+    critical 'API error: ' << e.message
+  end
+
+  def parse_list(list)
+    return list.split(',') if list && list.include?(',')
+    return [list] if list
+    ['']
+  end
+end

data/bin/check-kube-pods-running.rb

@@ -0,0 +1,104 @@
+#! /usr/bin/env ruby
+#
+#   check-kube-pods-running
+#
+# DESCRIPTION:
+# => Check if pods are in a running state
+#
+# OUTPUT:
+#   plain text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: kube-client
+#
+# Usage: ./check-kube-pods-running.rb (options)
+#         --ca-file CA-FILE            CA file to verify API server cert
+#         --cert CERT-FILE             Client cert to present
+#         --key KEY-FILE               Client key for the client cert
+#         --in-cluster                 Use service account authentication
+#         --password PASSWORD          If user is passed, also pass a password
+#     -s, --api-server URL             URL to API server
+#     -t, --token TOKEN                Bearer token for authorization
+#         --token-file TOKEN-FILE      File containing bearer token for authorization
+#     -u, --user USER                  User with access to API
+#     -v, --api-version VERSION        API version
+#     -n NAMESPACES,                   Exclude the specified list of namespaces
+#         --exclude-namespace
+#     -f, --filter FILTER              Selector filter for pods to be checked
+#     -p, --pods PODS                  List of pods to check
+# NOTES:
+# => The filter used for the -f flag is in the form key=value. If multiple
+#    filters need to be specfied, use a comma. ex. foo=bar,red=color
+#
+# LICENSE:
+#   Barry Martin <nyxcharon@gmail.com>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugins-kubernetes/cli'
+
+class AllPodsAreRunning < Sensu::Plugins::Kubernetes::CLI
+  @options = Sensu::Plugins::Kubernetes::CLI.options.dup
+
+  option :pod_list,
+         description: 'List of pods to check',
+         short: '-p PODS',
+         long: '--pods',
+         default: 'all'
+
+  option :pod_filter,
+         description: 'Selector filter for pods to be checked',
+         short: '-f FILTER',
+         long: '--filter'
+
+  option :exclude_namespace,
+         description: 'Exclude the specified list of namespaces',
+         short: '-n NAMESPACES',
+         long: '--exclude-namespace',
+         proc: proc { |a| a.split(',') },
+         default: ''
+
+  def run
+    pods_list = []
+    failed_pods = []
+    pods = []
+    if config[:pod_filter].nil?
+      pods_list = parse_list(config[:pod_list])
+      pods = client.get_pods
+    else
+      pods = client.get_pods(label_selector: config[:pod_filter].to_s)
+      if pods.empty?
+        unknown 'The filter specified resulted in 0 pods'
+      end
+      pods_list = ['all']
+    end
+    pods.each do |pod|
+      next if pod.nil?
+      next if config[:exclude_namespace].include?(pod.metadata.namespace)
+      next unless pods_list.include?(pod.metadata.name) || pods_list.include?('all')
+      next unless pod.status.phase != 'Succeeded' && !pod.status.conditions.nil?
+      if pod.status.conditions[1].status == 'False' # This is the Ready state
+        failed_pods << pod.metadata.name
+      end
+    end
+
+    if failed_pods.empty?
+      ok 'All pods are reporting as ready'
+    else
+      critical "Pods found in a non-ready state: #{failed_pods.join(' ')}"
+    end
+  rescue KubeException => e
+    critical 'API error: ' << e.message
+  end
+
+  def parse_list(list)
+    return list.split(',') if list && list.include?(',')
+    return [list] if list
+    ['']
+  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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-kubernetes
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-07 00:00:00.000000000 Z
+date: 2017-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
@@ -28,16 +28,16 @@ dependencies:
   name: kubeclient
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.3
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.3
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -184,9 +184,12 @@ 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:
@@ -196,9 +199,12 @@ files:
 - 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
@@ -229,7 +235,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Sensu plugins for kubernetes