kubeclient 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4cce5a424d82f97a745e142c887bb3f212e1cb44
-  data.tar.gz: bba2a4ba2dde980a5987d55b7dc16978a371ae29
+  metadata.gz: be8f06e6c46d5f6e8f202ff4f0b36d6474649b45
+  data.tar.gz: 678a768f43fab92d1e5368da223fb6a8f193b628
 SHA512:
-  metadata.gz: c4095bf9e4a000c1c42ef97aec6bae358decb35943193875003352a3ede9f50e156ad3cb4643d4f7c11d70505c38ad77711763a08b6d1f527a308b29622a3188
-  data.tar.gz: 6d516c2b91b6976cd4eb05f5c72e5044acfa9d8addd12829120628cab787d4911bab04e7cb504cffd4f0e987b4397a3af78337c43f47bd953ee5ec1d216fb5f7
+  metadata.gz: 6195902eb2f834c05346d9c6b8f8c200fd44e253451fb9b376486325804d700eddb50d7e35fdb4ba3e5ae48e338db4fea7e6ad156ca84e0033ba1723a7b550b5
+  data.tar.gz: ec74ebf40164b703d4442c3c77fd715ce1f662392e76ef4bc7ac448ae5a76f5937313dd5503fb361c03e1970b4576ef5776e4e3c8e6e37a871481db18c03d323

data/README.md

@@ -1,13 +1,13 @@
 # Kubeclient
 
 [![Gem Version](https://badge.fury.io/rb/kubeclient.svg)](http://badge.fury.io/rb/kubeclient)
-[![Build Status](https://travis-ci.org/abonas/kubeclient.svg)](https://travis-ci.org/abonas/kubeclient)
+[![Build Status](https://travis-ci.org/abonas/kubeclient.svg?branch=master)](https://travis-ci.org/abonas/kubeclient)
 [![Code Climate](http://img.shields.io/codeclimate/github/abonas/kubeclient.svg)](https://codeclimate.com/github/abonas/kubeclient)
 [![Dependency Status](https://gemnasium.com/abonas/kubeclient.svg)](https://gemnasium.com/abonas/kubeclient)
 
 A Ruby client for Kubernetes REST api.
 The client supports GET, POST, PUT, DELETE on nodes, pods, services, replication controllers and namespaces.
-The client currently supports Kubernetes REST api version v1beta1 and v1beta3.
+The client currently supports Kubernetes REST api version v1beta3.
 
 ## Installation
 
@@ -28,12 +28,18 @@ Or install it yourself as:
 ## Usage
 
 Initialize the client: <br>
-`client = Kubeclient::Client.new 'http://localhost:8080/api/' , "v1beta1"`
+`client = Kubeclient::Client.new 'http://localhost:8080/api/' , "v1beta3"`
 
 or for the v3:
 
 `client = Kubeclient::Client.new 'http://localhost:8080/api/' , "v1beta3"`
 
+Another option is to initialize the client with URI object:
+
+`uri = URI::HTTP.build(host: "somehostname", port: 8080)`
+`client = Kubeclient::Client.new uri`
+
+
 It is also possible to use https and configure ssl with:
 
 `client = Kubeclient::Client.new 'https://localhost:8443/api/' , "v1beta3"`
@@ -55,10 +61,10 @@ Examples:
 <br>
 `pods = client.get_pods`
 <br>
-You can get entities which have specific labels by specifying input parameter named `labels`: <br>
-`pods = client.get_pods(labels: 'name=redis-master')` <br>
+You can get entities which have specific labels by specifying input parameter named `label-selector`: <br>
+`pods = client.get_pods(label_selector: 'name=redis-master')` <br>
 You can specify multiple labels and that returns entities which have both labels:  <br>
-`pods = client.get_pods(labels: 'name=redis-master,app=redis')`
+`pods = client.get_pods(label_selector: 'name=redis-master,app=redis')`
 
 2. Get a specific node (and respectively: get_service "service id" , get_pod "pod id" , get_replication_controller "rc id" )
 <br>
@@ -75,25 +81,25 @@ Input parameter - id (string) specifying service id, pod id, replication control
 
 4. Create a service (and respectively: create_pod pod_object, create_replication_controller rc_obj) <br>
 Input parameter - object of type Service, Pod, ReplicationController. <br>
-The below example is for v1beta1
+The below example is for v1beta3
 <br>
 `service = Service.new` <br>
-`service.id = "redis-master"`<br>
-`service.port = 6379`<br>
-`service.containerPort  = "redis-server"`<br>
-`service.selector = {}`<br>
-`service.selector.name = "redis"`<br>
-`service.selector.role = "master"`<br>
+`service.metadata.name = "redis-master"`<br>
+`service.spec.port = 6379`<br>
+`service.spec.containerPort  = "redis-server"`<br>
+`service.spec.selector = {}`<br>
+`service.spec.selector.name = "redis"`<br>
+`service.spec.selector.role = "master"`<br>
 `client.create_service service`<br>
 <br>
 
 5. Update entity (update pod, service, replication controller) <br>
 Input parameter - object of type Service, Pod, ReplicationController <br>
-The below example is for v1beta1 <br>
+The below example is for v1beta3 <br>
 `client.update_service service1`
 <br>
 
-6. Get all entities - Returns a hash with 4 keys (node, service,pod, replication_controller). Each key points to an EntityList of same type. This method
+6. all_entities - Returns a hash with 7 keys (node, service, pod, replication_controller, namespace, endpoint and event). Each key points to an EntityList of same type. This method
  is a convenience method instead of calling each entity's get method separately. <br>
 `client.get_all_entities`
 

data/lib/kubeclient.rb

@@ -12,53 +12,61 @@ module Kubeclient
   class Client
     attr_reader :api_endpoint
 
-    ENTITY_TYPES = %w(Pod Service ReplicationController Node Event Endpoint
-                      Namespace)
-
     # Dynamically creating classes definitions (class Pod, class Service, etc.),
     # The classes are extending RecursiveOpenStruct.
     # This cancels the need to define the classes
     # manually on every new entity addition,
     # and especially since currently the class body is empty
-    ENTITY_TYPES.each do |entity_type|
-      Object.const_set(entity_type, Class.new(RecursiveOpenStruct))
+    ENTITY_TYPES = %w(Pod Service ReplicationController Node Event Endpoint
+                      Namespace).map do |et|
+      [Kubeclient.const_set(et, Class.new(RecursiveOpenStruct)), et]
     end
 
-    def initialize(uri, version)
+    def initialize(uri, version = 'v1beta3')
       @api_endpoint = (uri.is_a? URI) ? uri : URI.parse(uri)
-      @api_endpoint.merge!(File.join(@api_endpoint.path, version))
-      # version flag is needed to take care of the differences between
-      # versions
+      @api_endpoint.path = '/api/' if @api_endpoint.path.empty?
+      unless @api_endpoint.path.end_with? '/'
+        @api_endpoint.path = @api_endpoint.path + '/'
+      end
       @api_version = version
       ssl_options
     end
 
-    private
-
     def rest_client
-      options = {
-        ssl_ca_file:      @ssl_options[:ca_file],
-        verify_ssl:       @ssl_options[:verify_ssl],
-        ssl_client_cert:  @ssl_options[:client_cert],
-        ssl_client_key:   @ssl_options[:client_key]
-      }
-
-      # TODO: should a new one be created for every request?
-      RestClient::Resource.new(@api_endpoint, options)
+      @rest_client ||= begin
+        options = {
+          ssl_ca_file:      @ssl_options[:ca_file],
+          verify_ssl:       @ssl_options[:verify_ssl],
+          ssl_client_cert:  @ssl_options[:client_cert],
+          ssl_client_key:   @ssl_options[:client_key]
+        }
+        endpoint_with_version = @api_endpoint
+                                .merge("#{@api_endpoint.path}#{@api_version}")
+        RestClient::Resource.new(endpoint_with_version, options)
+      end
     end
 
-    def handling_kube_exception
+    private
+
+    def handle_exception
       yield
     rescue RestClient::Exception => e
-      raise KubeException.new(e.http_code, JSON.parse(e.response)['message'])
+      begin
+        err_message = JSON.parse(e.response)['message']
+      rescue JSON::ParserError
+        err_message = e.message
+      end
+      raise KubeException.new(e.http_code, err_message)
     end
 
-    def get_entities(entity_type, options)
+    def get_entities(entity_type, klass, options)
       params = {}
-      params['labels'] = options[:labels] if options[:labels]
+      if options[:label_selector]
+        params['label-selector'] = options[:label_selector]
+      end
 
       # TODO: namespace support?
-      response = handling_kube_exception do
+      response = handle_exception do
         rest_client[get_resource_name(entity_type)].get(params: params)
       end
 
@@ -70,20 +78,17 @@ module Kubeclient
           result.fetch('metadata', {}).fetch('resourceVersion', nil)
       end
 
-      collection = EntityList.new(entity_type, resource_version)
+      collection = result['items'].map { |item| new_entity(item, klass) }
 
-      result['items'].each do |item|
-        collection.push(new_entity(item, entity_type))
-      end
-
-      collection
+      EntityList.new(entity_type, resource_version, collection)
     end
 
     def watch_entities(entity_type, resource_version = nil)
       resource_name = get_resource_name(entity_type.to_s)
 
-      uri = api_endpoint.merge(
-        File.join(api_endpoint.path, 'watch', resource_name))
+      uri = @api_endpoint
+            .merge("#{@api_endpoint.path}#{@api_version}/watch/" \
+                      "#{resource_name}")
 
       unless resource_version.nil?
         uri.query = URI.encode_www_form('resourceVersion' => resource_version)
@@ -100,16 +105,16 @@ module Kubeclient
       WatchStream.new(uri, options)
     end
 
-    def get_entity(entity_type, id)
-      response = handling_kube_exception do
+    def get_entity(entity_type, klass, id)
+      response = handle_exception do
         rest_client[get_resource_name(entity_type) + "/#{id}"].get
       end
       result = JSON.parse(response)
-      new_entity(result, entity_type)
+      new_entity(result, klass)
     end
 
     def delete_entity(entity_type, id)
-      handling_kube_exception do
+      handle_exception do
         rest_client[get_resource_name(entity_type) + "/#{id}"].delete
       end
     end
@@ -118,7 +123,7 @@ module Kubeclient
       # to_hash should be called because of issue #9 in recursive open
       # struct
       hash = entity_config.to_hash
-      handling_kube_exception do
+      handle_exception do
         rest_client[get_resource_name(entity_type)].post(hash.to_json)
       end
     end
@@ -131,23 +136,19 @@ module Kubeclient
       # TODO: temporary solution to delete id till this issue is solved
       # https://github.com/GoogleCloudPlatform/kubernetes/issues/3085
       hash.delete(:id)
-      handling_kube_exception do
+      handle_exception do
         rest_client[get_resource_name(entity_type) + "/#{id}"].put(hash.to_json)
       end
     end
 
     protected
 
-    def new_entity(hash, entity_type)
-      entity_type.classify.constantize.new(hash)
+    def new_entity(hash, klass)
+      klass.new(hash)
     end
 
     def get_resource_name(entity_type)
-      if @api_version == 'v1beta1'
-        entity_type.pluralize.camelize(:lower)
-      else
-        entity_type.pluralize.downcase
-      end
+      entity_type.pluralize.downcase
     end
 
     public
@@ -162,13 +163,13 @@ module Kubeclient
       }
     end
 
-    ENTITY_TYPES.each do |entity_type|
+    ENTITY_TYPES.each do |klass, entity_type|
       entity_name = entity_type.underscore
       entity_name_plural = entity_name.pluralize
 
       # get all entities of a type e.g. get_nodes, get_pods, etc.
       define_method("get_#{entity_name_plural}") do |options = {}|
-        get_entities(entity_type, options)
+        get_entities(entity_type, klass, options)
       end
 
       # watch all entities of a type e.g. watch_nodes, watch_pods, etc.
@@ -178,7 +179,7 @@ module Kubeclient
 
       # get a single entity of a specific type by id
       define_method("get_#{entity_name}") do |id|
-        get_entity(entity_type, id)
+        get_entity(entity_type, klass, id)
       end
 
       define_method("delete_#{entity_name}") do |id|
@@ -195,7 +196,7 @@ module Kubeclient
     end
 
     def all_entities
-      ENTITY_TYPES.each_with_object({}) do |entity_type, result_hash|
+      ENTITY_TYPES.each_with_object({}) do |(_, entity_type), result_hash|
         # method call for get each entities
         # build hash of entity name to array of the entities
         method_name = "get_#{entity_type.underscore.pluralize}"
@@ -203,5 +204,17 @@ module Kubeclient
         result_hash[key_name] = send(method_name)
       end
     end
+
+    def api
+      response = handle_exception do
+        RestClient::Resource.new(@api_endpoint.to_s).get
+      end
+      JSON.parse(response)
+    end
+
+    def api_valid?
+      result = api
+      result.is_a?(Hash) && result['versions'].is_a?(Array)
+    end
   end
 end

data/lib/kubeclient/entity_list.rb

@@ -1,11 +1,15 @@
-# Kubernetes Entity List
-class EntityList < Array
-  attr_reader :kind, :resourceVersion
+require 'delegate'
 
-  def initialize(kind, resource_version)
-    @kind = kind
-    # rubocop:disable Style/VariableName
-    @resourceVersion = resource_version
-    super()
+module Kubeclient
+  # Kubernetes Entity List
+  class EntityList < DelegateClass(Array)
+    attr_reader :kind, :resourceVersion
+
+    def initialize(kind, resource_version, list)
+      @kind = kind
+      # rubocop:disable Style/VariableName
+      @resourceVersion = resource_version
+      super(list)
+    end
   end
 end

data/lib/kubeclient/version.rb

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

data/test/json/entity_list_b3.json

@@ -0,0 +1,56 @@
+{
+    "kind": "ServiceList",
+    "apiVersion": "v1beta3",
+    "metadata": {
+        "selfLink": "/api/v1beta3/services",
+        "resourceVersion": "59"
+    },
+    "items": [
+        {
+            "metadata": {
+                "name": "kubernetes",
+                "namespace": "default",
+                "selfLink": "/api/v1beta3/services/kubernetes?namespace=default",
+                "uid": "016e9dcd-ce39-11e4-ac24-3c970e4a436a",
+                "resourceVersion": "6",
+                "creationTimestamp": "2015-03-19T15:08:16+02:00",
+                "labels": {
+                    "component": "apiserver",
+                    "provider": "kubernetes"
+                }
+            },
+            "spec": {
+                "port": 443,
+                "protocol": "TCP",
+                "selector": null,
+                "portalIP": "10.0.0.2",
+                "containerPort": 0,
+                "sessionAffinity": "None"
+            },
+            "status": {}
+        },
+        {
+            "metadata": {
+                "name": "kubernetes-ro",
+                "namespace": "default",
+                "selfLink": "/api/v1beta3/services/kubernetes-ro?namespace=default",
+                "uid": "015b78bf-ce39-11e4-ac24-3c970e4a436a",
+                "resourceVersion": "5",
+                "creationTimestamp": "2015-03-19T15:08:15+02:00",
+                "labels": {
+                    "component": "apiserver",
+                    "provider": "kubernetes"
+                }
+            },
+            "spec": {
+                "port": 80,
+                "protocol": "TCP",
+                "selector": null,
+                "portalIP": "10.0.0.1",
+                "containerPort": 0,
+                "sessionAffinity": "None"
+            },
+            "status": {}
+        }
+    ]
+}

data/test/json/get_all_services_b3.json

@@ -0,0 +1,56 @@
+{
+    "kind": "ServiceList",
+    "apiVersion": "v1beta3",
+    "metadata": {
+        "selfLink": "/api/v1beta3/services",
+        "resourceVersion": "59"
+    },
+    "items": [
+        {
+            "metadata": {
+                "name": "kubernetes",
+                "namespace": "default",
+                "selfLink": "/api/v1beta3/services/kubernetes?namespace=default",
+                "uid": "016e9dcd-ce39-11e4-ac24-3c970e4a436a",
+                "resourceVersion": "6",
+                "creationTimestamp": "2015-03-19T15:08:16+02:00",
+                "labels": {
+                    "component": "apiserver",
+                    "provider": "kubernetes"
+                }
+            },
+            "spec": {
+                "port": 443,
+                "protocol": "TCP",
+                "selector": null,
+                "portalIP": "10.0.0.2",
+                "containerPort": 0,
+                "sessionAffinity": "None"
+            },
+            "status": {}
+        },
+        {
+            "metadata": {
+                "name": "kubernetes-ro",
+                "namespace": "default",
+                "selfLink": "/api/v1beta3/services/kubernetes-ro?namespace=default",
+                "uid": "015b78bf-ce39-11e4-ac24-3c970e4a436a",
+                "resourceVersion": "5",
+                "creationTimestamp": "2015-03-19T15:08:15+02:00",
+                "labels": {
+                    "component": "apiserver",
+                    "provider": "kubernetes"
+                }
+            },
+            "spec": {
+                "port": 80,
+                "protocol": "TCP",
+                "selector": null,
+                "portalIP": "10.0.0.1",
+                "containerPort": 0,
+                "sessionAffinity": "None"
+            },
+            "status": {}
+        }
+    ]
+}