kubeclient 1.1.4 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f768aad498e66fa0f505eeb189e8b16ba540d18
-  data.tar.gz: cb9117eec7974802515d05073815eb3615c02753
+  metadata.gz: bc17e4674c3ba30929ff7269036b8ece9c803d27
+  data.tar.gz: 1d6e55bd1fdd2fd7f05e1984cf43e4622c550416
 SHA512:
-  metadata.gz: dfb530cff6a49e8a3b1100da06a520bec3341b862f79829b19de34819c4ccabb8cbe6b228619c2c8728d1885a796777df5d591d87b2991b4652797db503080c8
-  data.tar.gz: 3241b347cceeed5453a980fb412a39b9455255e1c73a016277adf67a4f1aeaa1ed690b1d7507edaf2fb5d6167590bd79732eaf69ea853dd3a74e6b52e6fe94a4
+  metadata.gz: 17a5534c7be7404ff9e5b376d6c2571582fc6c6ac795301445bdd40361aa27029db856ef0367ce8d52f125fa47e8dc5c4b0c8ec3ab1c8347001e364a17542d41
+  data.tar.gz: 7e847c215609634b3c9d15e961c872aaab6792a95e785d9b2aeb62891acd838d628f257688fa2ea4a81494129eb56e3510106234805dac7fe40004bdea7fd472

data/README.md

@@ -64,7 +64,7 @@ As an alternative to the `ca_file` it's possible to use the `cert_store`:
 cert_store = OpenSSL::X509::Store.new
 cert_store.add_cert(OpenSSL::X509::Certificate.new(ca_cert_data))
 ssl_options = {
-  cert_store: cert_store
+  cert_store: cert_store,
   verify_ssl: OpenSSL::SSL::VERIFY_PEER
 }
 client = Kubeclient::Client.new 'https://localhost:8443/api/' , "v1",
@@ -140,6 +140,14 @@ client = Kubeclient::Client.new 'https://localhost:8443/api/' , 'v1',
                                 socket_options: socket_options
 ```
 
+You can also use kubeclient with an http proxy server such as tinyproxy. It can be entered as a string or a URI object
+For example:
+```ruby
+proxy_uri = URI::HTTP.build(host: "myproxyhost", port: 8443)
+client = Kubeclient::Client.new('https://localhost:8443/api/',
+                                :http_proxy_uri => proxy_uri)
+```
+
 ## Examples:
 
 #### Get all instances of a specific entity type

data/lib/kubeclient/common.rb

@@ -24,9 +24,12 @@ module Kubeclient
       ssl_socket_class: nil
     }.freeze
 
+    DEFAULT_HTTP_PROXY_URI = nil
+
     attr_reader :api_endpoint
     attr_reader :ssl_options
     attr_reader :auth_options
+    attr_reader :http_proxy_uri
     attr_reader :headers
 
     def initialize_client(
@@ -35,7 +38,8 @@ module Kubeclient
       version,
       ssl_options: DEFAULT_SSL_OPTIONS,
       auth_options: DEFAULT_AUTH_OPTIONS,
-      socket_options: DEFAULT_SOCKET_OPTIONS
+      socket_options: DEFAULT_SOCKET_OPTIONS,
+      http_proxy_uri: DEFAULT_HTTP_PROXY_URI
     )
       validate_auth_options(auth_options)
       handle_uri(uri, path)
@@ -45,6 +49,7 @@ module Kubeclient
       @ssl_options = ssl_options
       @auth_options = auth_options
       @socket_options = socket_options
+      @http_proxy_uri = http_proxy_uri.to_s if http_proxy_uri
 
       if auth_options[:bearer_token]
         bearer_token(@auth_options[:bearer_token])
@@ -134,6 +139,7 @@ module Kubeclient
         verify_ssl: @ssl_options[:verify_ssl],
         ssl_client_cert: @ssl_options[:client_cert],
         ssl_client_key: @ssl_options[:client_key],
+        proxy: @http_proxy_uri,
         user: @auth_options[:username],
         password: @auth_options[:password]
       }
@@ -361,7 +367,8 @@ module Kubeclient
       options = {
         basic_auth_user: @auth_options[:username],
         basic_auth_password: @auth_options[:password],
-        headers: @headers
+        headers: @headers,
+        http_proxy_uri: @http_proxy_uri
       }
 
       if uri.scheme == 'https'

data/lib/kubeclient/config.rb

@@ -6,12 +6,13 @@ module Kubeclient
   class Config
     # Kubernetes client configuration context class
     class Context
-      attr_reader :api_endpoint, :api_version, :ssl_options
+      attr_reader :api_endpoint, :api_version, :ssl_options, :auth_options
 
-      def initialize(api_endpoint, api_version, ssl_options)
+      def initialize(api_endpoint, api_version, ssl_options, auth_options)
         @api_endpoint = api_endpoint
         @api_version = api_version
         @ssl_options = ssl_options
+        @auth_options = auth_options
       end
     end
 
@@ -35,6 +36,7 @@ module Kubeclient
       ca_cert_data     = fetch_cluster_ca_data(cluster)
       client_cert_data = fetch_user_cert_data(user)
       client_key_data  = fetch_user_key_data(user)
+      auth_options     = fetch_user_auth_options(user)
 
       ssl_options = {}
 
@@ -55,7 +57,7 @@ module Kubeclient
         ssl_options[:client_key] = OpenSSL::PKey.read(client_key_data)
       end
 
-      Context.new(cluster['server'], @kcfg['apiVersion'], ssl_options)
+      Context.new(cluster['server'], @kcfg['apiVersion'], ssl_options, auth_options)
     end
 
     private
@@ -107,5 +109,17 @@ module Kubeclient
         return Base64.decode64(user['client-key-data'])
       end
     end
+
+    def fetch_user_auth_options(user)
+      options = {}
+      if user.key?('token')
+        options[:bearer_token] = user['token']
+      else
+        %w(username password).each do |attr|
+          options[attr.to_sym] = user[attr] if user.key?(attr)
+        end
+      end
+      options
+    end
   end
 end

data/lib/kubeclient/version.rb

@@ -1,4 +1,4 @@
 # Kubernetes REST-API Client
 module Kubeclient
-  VERSION = '1.1.4'
+  VERSION = '1.2.0'
 end

data/lib/kubeclient/watch_stream.rb

@@ -47,8 +47,23 @@ module Kubeclient
         end
       end
 
+      def using_proxy
+        proxy = @http_options[:http_proxy_uri]
+        return nil unless proxy
+        p_uri = URI.parse(proxy)
+        {
+          proxy_address: p_uri.hostname,
+          proxy_port: p_uri.port,
+          proxy_username: p_uri.user,
+          proxy_password: p_uri.password
+        }
+      end
+
       def build_client_options
-        client_options = { headers: @http_options[:headers] }
+        client_options = {
+          headers: @http_options[:headers],
+          proxy: using_proxy
+        }
         if @http_options[:ssl]
           client_options[:ssl] = @http_options[:ssl]
           client_options[:ssl_socket_class] =

data/test/config/userauth.kubeconfig

@@ -0,0 +1,28 @@
+apiVersion: v1
+clusters:
+- cluster:
+    server: https://localhost:8443
+    insecure-skip-tls-verify: true
+  name: localhost:8443
+contexts:
+- context:
+    cluster: localhost:8443
+    namespace: default
+    user: system:admin:token
+  name: localhost/system:admin:token
+- context:
+    cluster: localhost:8443
+    namespace: default
+    user: system:admin:userpass
+  name: localhost/system:admin:userpass
+current-context: localhost/system:admin:token
+kind: Config
+preferences: {}
+users:
+- name: system:admin:token
+  user:
+    token: 0123456789ABCDEF0123456789ABCDEF
+- name: system:admin:userpass
+  user:
+    username: admin
+    password: pAssw0rd123

data/test/test_config.rb

@@ -24,6 +24,25 @@ class KubeClientConfigTest < MiniTest::Test
     check_context(config.context, ssl: false)
   end
 
+  def test_user_token
+    config = Kubeclient::Config.read(test_config_file('userauth.kubeconfig'))
+    assert_equal(['localhost/system:admin:token', 'localhost/system:admin:userpass'],
+                 config.contexts)
+    context = config.context('localhost/system:admin:token')
+    check_context(context, ssl: false)
+    assert_equal('0123456789ABCDEF0123456789ABCDEF', context.auth_options[:bearer_token])
+  end
+
+  def test_user_password
+    config = Kubeclient::Config.read(test_config_file('userauth.kubeconfig'))
+    assert_equal(['localhost/system:admin:token', 'localhost/system:admin:userpass'],
+                 config.contexts)
+    context = config.context('localhost/system:admin:userpass')
+    check_context(context, ssl: false)
+    assert_equal('admin', context.auth_options[:username])
+    assert_equal('pAssw0rd123', context.auth_options[:password])
+  end
+
   private
 
   def check_context(context, ssl: true)

data/test/test_kubeclient.rb

@@ -38,6 +38,18 @@ class KubeClientTest < MiniTest::Test
     assert_equal 'http://localhost:8080/api/v1', rest_client.url.to_s
   end
 
+  def test_pass_proxy
+    uri = URI::HTTP.build(host: 'localhost', port: 8080)
+    proxy_uri = URI::HTTP.build(host: 'myproxyhost', port: 8888)
+    client = Kubeclient::Client.new(uri, http_proxy_uri: proxy_uri)
+    rest_client = client.rest_client
+    assert_equal proxy_uri.to_s, rest_client.options[:proxy]
+
+    watch_client = client.watch_pods
+    assert_equal(watch_client.send(:build_client_options)[:proxy][:proxy_address], proxy_uri.host)
+    assert_equal(watch_client.send(:build_client_options)[:proxy][:proxy_port], proxy_uri.port)
+  end
+
   def test_exception
     stub_request(:post, %r{/services})
       .to_return(body: open_test_file('namespace_exception.json'),

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubeclient
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.2.0
 platform: ruby
 authors:
 - Alissa Bonas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-28 00:00:00.000000000 Z
+date: 2016-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -180,6 +180,7 @@ files:
 - test/config/external-key.rsa
 - test/config/external.kubeconfig
 - test/config/nouser.kubeconfig
+- test/config/userauth.kubeconfig
 - test/json/component_status.json
 - test/json/component_status_list.json
 - test/json/created_endpoint.json
@@ -271,6 +272,7 @@ test_files:
 - test/config/external-key.rsa
 - test/config/external.kubeconfig
 - test/config/nouser.kubeconfig
+- test/config/userauth.kubeconfig
 - test/json/component_status.json
 - test/json/component_status_list.json
 - test/json/created_endpoint.json