sensu-plugins-kubernetes 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da62b54a627d8cb692fc340e5e004d31f4c836cf
-  data.tar.gz: ffa06f5b83a3e6539a9934929354dc2658873ae3
+  metadata.gz: 36157c792a8bec58626218b903748035f536c988
+  data.tar.gz: 5b423f2c185b3f00527889355469884182d866f1
 SHA512:
-  metadata.gz: d1652721603c4ca51d28f1fdb4248b189c0535722902f8355480cfd1f91f2d7e6761a31c278e5d39db1fff78b42e9ccd183eeb164744d371331bb1fb59df825d
-  data.tar.gz: 26b2e69ce1a96ccff4f9bb053e65476d7fe1984e48e83d79b53022d83679c7af14a36ead9aec3194311420f891dc0b35c3880ead9c7ad95a1d35e7cb7548869a
+  metadata.gz: c350b9c7ab40bfa371b2df8ddacdb56207203e2294252b9c7f34a4e92f7845082bbeab91dcaf9debb794c7b67e1342d5e6f39c8652432eabd7c3a737d7c56af7
+  data.tar.gz: e025312b7dbcaaf10c85c48ddb5c1d0964ee6a4ce5c5510a5563ad327268c7cdf0affe3f6a91ec4e330b11c0533df8da2b66c9eafe19848b165778845b82a42f

data/CHANGELOG.md

@@ -5,6 +5,11 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 
 ## [Unreleased]
 
+## [1.1.0] - 2017-08-11
+### Added
+- Ruby 2.4.1 testing (@thomasriley)
+- Add option to use kubeconfig file for auth and TLS (@jaxxstorm)
+
 ## [1.0.0] - 2017-03-21
 ### Added
 - Add `metrics-pods.rb` that will output the number of running pods per service (@mickfeech)
@@ -49,7 +54,8 @@ pending pods, the restart count portion has been split into it's own check, `che
 ### Added
 - initial release
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-kubernetes/compare/1.0.0...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-kubernetes/compare/1.1.0...HEAD
+[1.1.0]: https://github.com/sensu-plugins/sensu-plugins-kubernetes/compare/1.0.0...1.1.0
 [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

data/README.md

@@ -35,6 +35,7 @@ Usage: check-kube-nodes-ready.rb (options)
         --token-file TOKEN-FILE      File containing bearer token for authorization
     -u, --user USER                  User with access to API
     -v, --api-version VERSION        API version
+        --kube-config KUBECONFIG     Path to a kube config file
 ```
 
 **check-kube-apiserver-available.rb**
@@ -49,6 +50,7 @@ Usage: check-kube-apiserver-available.rb (options)
     -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
+        --kube-config KUBECONFIG     Path to a kube config file
 ```
 
 **check-kube-pods-pending.rb**
@@ -70,6 +72,7 @@ Usage: check-kube-pods-pending.rb (options)
     -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
+        --kube-config KUBECONFIG     Path to a kube config file
 ```
 
 **check-kube-service-available.rb**
@@ -87,6 +90,7 @@ Usage: check-kube-service-available.rb (options)
     -v, --api-version VERSION        API version
     -p, --pending SECONDS            Time (in seconds) a pod may be pending for and be valid
     -l, --list SERVICES              List of services to check (required)
+        --kube-config KUBECONFIG     Path to a kube config file
 ```
 
 **check-kube-pods-runtime.rb**
@@ -106,6 +110,7 @@ Usage: check-kube-pods-runtime.rb (options)
     -f, --filter FILTER              Selector filter for pods to be checked
     -p, --pods PODS                  List of pods to check
     -w, --warn TIMEOUT               Threshold for pods to be in the pending state
+        --kube-config KUBECONFIG     Path to a kube config file
 ```
 
 **check-kube-pods-running.rb**
@@ -125,6 +130,7 @@ Usage: ./check-kube-pods-running.rb (options)
         --exclude-namespace
     -f, --filter FILTER              Selector filter for pods to be checked
     -p, --pods PODS                  List of pods to check
+        --kube-config KUBECONFIG     Path to a kube config file
 ```
 
 **check-kube-pods-restarting.rb**
@@ -146,6 +152,7 @@ Usage: ./check-kube-pods-restarting.rb (options)
     -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
+        --kube-config KUBECONFIG     Path to a kube config file
 ```
 
 **handler-kube-pod.rb**
@@ -186,6 +193,7 @@ Usage: metrics-pods.rb (options)
         --token-file TOKEN-FILE      File containing bearer token for authorization
         -u, --user USER                  User with access to API
         -v, --api-version VERSION        API version
+            --kube-config KUBECONFIG     Path to a kube config file
 ```
 
 `api_server` and `api_version` can still be used for backwards compatibility,
@@ -209,6 +217,7 @@ Of the Kubernetes connection options:
 --password PASSWORD          If user is passed, also pass a password
 --token TOKEN                Bearer token for authorization
 --token-file TOKEN-FILE      File containing bearer token for authorization
+--kube-config KUBECONFIG     Path to a kube config file
 ```
 Only the API server option is required, however it does default to the `KUBERNETES_MASTER` environment variable, or you can use the in-cluster option. The other options are to be used as needed.
 
@@ -227,3 +236,5 @@ Only one of the authentication methods (user, token, or token file) can be used.
 For example, using a username and a token, or a token and a token file, will produce an error.
 
 If the 'user' authentication method is used, a password must also be provided.
+
+The kubeconfig options enable the usage of a kubeconfig file, which is a yaml file which defines the authentication and TLS config. More information about kubeconfig files can be found in the [Kubernetes Docs](https://kubernetes.io/docs/tasks/access-application-cluster/authenticate-across-clusters-kubeconfig/)

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

@@ -66,6 +66,11 @@ module Sensu
                long: '--token-file TOKEN-FILE',
                default: nil
 
+        option :kube_config,
+               description: 'Path to a kube config file',
+               long: '--kube-config KUBECONFIG',
+               default: nil
+
         attr_reader :client
 
         # Initializes the Sensu check by creating a Kubernetes client
@@ -84,7 +89,8 @@ module Sensu
               username: config[:api_user],
               password: config[:api_password],
               token: config[:api_token],
-              token_file: config[:api_token_file]
+              token_file: config[:api_token_file],
+              kube_config: config[:kube_config]
             )
           rescue ArgumentError => e
             critical e.message

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

@@ -38,6 +38,8 @@ module Sensu
         #   The bearer token for Kubernetes authorization
         # @option options [String] :token_file
         #   A file containing the bearer token for Kubernetes authorization
+        # @option options [String] :kube_config
+        #   A file containing kubeconfig yaml configuration
         #
         # @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.
@@ -46,18 +48,32 @@ module Sensu
         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 options[:kube_config]
+            begin
+              config = Kubeclient::Config.read(options[:kube_config])
+
+              api_server = config.context.api_endpoint
+              api_version = config.context.api_version
+
+              ssl_options = config.context.ssl_options
+              auth_options = config.context.auth_options
+            rescue => e
+              raise e, "Unable to read kubeconfig: #{e}", e.backtrace
+            end
+          else
+            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]
+            }
+          end
 
           if [:client_cert_file, :client_key_file].count { |k| options[k] } == 1
             raise ArgumentError, 'SSL requires both client cert and client key'

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-kubernetes
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-21 00:00:00.000000000 Z
+date: 2017-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin