kubeclient 0.0.9 → 0.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NjNjZWFmODFkZjQxMGNjNWNlYTAxNTZmNWM2NDNkM2E2NjcxNDgwNQ==
+    ZTU4ZWFlNzhiODQ2M2ViM2JiNjJhOGYyMWUzMDVmZGI1MzU1ZjcxYw==
   data.tar.gz: !binary |-
-    NThhYjA4Y2Y4YTk3MGY3ZTlkMDM4M2QxZTU5ODRlNmY3NzdjMWI1ZA==
+    Nzg4ZTc2OTlhOGVjZTZjN2MzYWU1ZWZlYTZhMmU5MDQwNTM3MDI2NA==
 SHA512:
   metadata.gz: !binary |-
-    YWUyMWMxMzU3NmQ0NDI1OGE0ZjM5NzJlZDFkMzMxMDg2MzNjNGMyNjY0ZTA4
-    MzJiZjliODc1NjIzODA4NjQ0YzU5ZTRjNzhkMTgzMmVhNzg4ZDRhMjNhMzBm
-    MDhmZDRhMTJmZmMxZWM3YTE0YjU5Y2ZkNWEzYWJmMzUxZDIwNTQ=
+    NDE4OTkyNmE4NjIwMDVjM2QyOGI3YmE4MTU0ODllMDFlZTU4NGMyNzA3OWY2
+    N2EzMGY3OGZhNGQ4MTk1OWM2NDY5MWNhMWRlY2E4MTNjZjQ4NmI3NjVjMWJi
+    OTliYjZlZGUyMWU1MDQzNWY2MGRlMjI1Y2RhMGE1NDBiMWQzYzk=
   data.tar.gz: !binary |-
-    YTQ3ZGMyMDgxMDE0OWJhNTdlZjJjMmRhMDdjNDdiMThhZGYxZjc3MjA4YWZj
-    MDE5YTYzYjllNTIwNWZlMDQ5NDI4YjU1NmU2ODdjMTEzNzM1YjkwNTViOTg3
-    MGY4NTBjM2M4ODVhMWU5MDNhM2RhYWUzNzU5OWVhMmRkMTZhMTA=
+    YWE1OGYzYTdjNTYyYzAxMDNmOTk0YTdmNzA5NGE0OGYwODI2MGZkMGVjYTgx
+    YTI0OGEzM2QxNmRhMTA0OWY5OTZkMjU0OWZmMjY4NDAyMzI0N2EzZGZmZDUw
+    OTBjOGNjZjAxYjdmMmU1NjY1NjU5YTYzYjQ4NWU5ZWMyNWZlMzY=

data/README.md

@@ -3,7 +3,7 @@
 A Ruby client for Kubernetes REST api.
 The client supports GET, POST, PUT, DELETE on pods, services and replication controllers.
 Also, GET and DELETE is supported for nodes.
-The client currently supports Kubernetes REST api version v1beta1.
+The client currently supports Kubernetes REST api version v1beta1 and v1beta3.
 
 ## Installation
 
@@ -23,15 +23,13 @@ Or install it yourself as:
 
 ## Usage
 
-Please note that all the properties in json objects
-are converted to ruby style in the client (and converted back to k8s side
-before sent to k8s).
-So, containerPort on k8s side is container_port in the client.
-resourceVersion --> resource_version
-
 Initialize the client: <br>
 `client = Kubeclient::Client.new 'http://localhost:8080/api/' , "v1beta1"`
 
+or for the v3:
+
+`client = Kubeclient::Client.new 'http://localhost:8080/api/' , "v1beta3"`
+
 Examples:
 
 1. Get all pods (and respectively: get_services, get_nodes, get_replication_controllers)
@@ -53,12 +51,13 @@ Input parameter - id (string) specifying service id, pod id, replication control
 <br>
 
 4. Create a service (and respectively: create_pod pod_object, create_replication_controller rc_obj) <br>
-Input parameter - object of type Service, Pod, ReplicationController
+Input parameter - object of type Service, Pod, ReplicationController. <br>
+The below example is for v1beta1
 <br>
 `service = Service.new` <br>
 `service.id = "redis-master"`<br>
 `service.port = 6379`<br>
-`service.container_port  = "redis-server"`<br>
+`service.containerPort  = "redis-server"`<br>
 `service.selector = {}`<br>
 `service.selector.name = "redis"`<br>
 `service.selector.role = "master"`<br>
@@ -67,6 +66,7 @@ Input parameter - object of type Service, Pod, ReplicationController
 
 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>
 `client.update_service service1`
 <br>
 

data/lib/kubeclient.rb

@@ -35,6 +35,15 @@ module Kubeclient
       entity.classify.constantize.new(hash)
     end
 
+    def get_resource_name(entity)
+      if @api_version == "v1beta1"
+        entity_name = entity.pluralize.camelize(:lower)
+      else
+        entity_name = entity.pluralize.downcase
+      end
+      entity_name
+    end
+
 
     public
 
@@ -45,7 +54,7 @@ module Kubeclient
        #todo labels support
        #todo namespace support?
        begin
-         response = rest_client[entity.pluralize.camelize(:lower)].get # nil, labels
+         response = rest_client[get_resource_name(entity)].get # nil, labels
        rescue  RestClient::Exception => e
          exception = KubeException.new(e.http_code, JSON.parse(e.response)['message'] )
          raise exception
@@ -59,7 +68,7 @@ module Kubeclient
      #get a single entity of a specific type by id
      define_method("get_#{entity.underscore}") do |id|
        begin
-         response = rest_client[entity.pluralize.camelize(:lower)+"/#{id}"].get
+         response = rest_client[get_resource_name(entity)+"/#{id}"].get
        rescue  RestClient::Exception => e
          exception = KubeException.new(e.http_code, JSON.parse(e.response)['message'] )
          raise exception
@@ -70,7 +79,7 @@ module Kubeclient
 
      define_method("delete_#{entity.underscore}") do |id|
        begin
-         rest_client[entity.underscore.pluralize+"/" +id].delete
+         rest_client[get_resource_name(entity)+"/" +id].delete
        rescue  RestClient::Exception => e
          exception = KubeException.new(e.http_code, JSON.parse(e.response)['message'] )
          raise exception
@@ -82,7 +91,7 @@ module Kubeclient
        #to_hash should be called because of issue #9 in recursive open struct
        hash = entity_config.to_hash
        begin
-         rest_client[entity.pluralize.camelize(:lower)].post(hash.to_json)
+         rest_client[get_resource_name(entity)].post(hash.to_json)
        rescue  RestClient::Exception => e
          exception = KubeException.new(e.http_code, JSON.parse(e.response)['message'] )
          raise exception
@@ -96,7 +105,7 @@ module Kubeclient
        #temporary solution to delete id till this issue is solved: https://github.com/GoogleCloudPlatform/kubernetes/issues/3085
        hash.delete(:id)
        begin
-         rest_client[entity.underscore.pluralize+"/#{id}"].put(hash.to_json)
+         rest_client[get_resource_name(entity)+"/#{id}"].put(hash.to_json)
        rescue  RestClient::Exception => e
          exception = KubeException.new(e.http_code, JSON.parse(e.response)['message'] )
          raise exception

data/lib/kubeclient/version.rb

@@ -1,3 +1,3 @@
 module Kubeclient
-  VERSION = "0.0.9"
+  VERSION = "0.1.0"
 end

data/test/node_test.rb

@@ -5,7 +5,7 @@ require 'json'
 require './lib/kubeclient'
 
 class NodeTest < MiniTest::Test
-  def test_get_from_json
+  def test_get_from_json_v1
     json_response = "{\n  \"kind\": \"Node\",\n  \"id\": \"127.0.0.1\",\n  \"uid\": \"b0ddfa00-8b5b-11e4-a8c4-3c970e4a436a\",\n  \"creationTimestamp\": \"2014-12-24T12:57:45+02:00\",\n  \"selfLink\": \"/api/v1beta1/nodes/127.0.0.1\",\n  \"resourceVersion\": 7,\n  \"apiVersion\": \"v1beta1\",\n  \"resources\": {\n    \"capacity\": {\n      \"cpu\": 1000,\n      \"memory\": 3221225472\n    }\n  }\n}"
 
     stub_request(:get, /.*nodes*/).
@@ -15,7 +15,6 @@ class NodeTest < MiniTest::Test
     node = client.get_node "127.0.0.1"
 
     assert_instance_of(Node,node)
-    #checking that creationTimestamp was renamed properly
     assert_respond_to(node, "creationTimestamp")
     assert_respond_to(node, "uid")
     assert_respond_to(node, "id")
@@ -27,4 +26,23 @@ class NodeTest < MiniTest::Test
     assert_equal 1000, node.resources.capacity.cpu
   end
 
+  def test_get_from_json_v3
+    json_response = "{\n  \"kind\": \"Node\",\n  \"apiVersion\": \"v1beta3\",\n  \"metadata\": {\n    \"name\": \"127.0.0.1\",\n    \"selfLink\": \"/api/v1beta3/nodes/127.0.0.1\",\n    \"uid\": \"01018013-a231-11e4-a36b-3c970e4a436a\",\n    \"resourceVersion\": \"7\",\n    \"creationTimestamp\": \"2015-01-22T14:20:08+02:00\"\n  },\n  \"spec\": {\n    \"capacity\": {\n      \"cpu\": \"1\",\n      \"memory\": \"3Gi\"\n    }\n  },\n  \"status\": {\n    \"hostIP\": \"127.0.0.1\",\n    \"conditions\": [\n      {\n        \"kind\": \"Ready\",\n        \"status\": \"Full\",\n        \"lastTransitionTime\": null\n      }\n    ]\n  }\n}"
+
+    stub_request(:get, /.*nodes*/).
+        to_return(:body => json_response, :status => 200)
+
+    client = Kubeclient::Client.new 'http://localhost:8080/api/' , "v1beta3"
+    node = client.get_node "127.0.0.1"
+
+    assert_instance_of(Node,node)
+
+    assert_equal("01018013-a231-11e4-a36b-3c970e4a436a", node.metadata.uid)
+    assert_equal("127.0.0.1", node.metadata.name)
+    assert_equal("7", node.metadata.resourceVersion)
+    assert_equal("v1beta3", node.apiVersion)
+    assert_equal("2015-01-22T14:20:08+02:00", node.metadata.creationTimestamp)
+
+  end
+
 end

data/test/pod_test.rb

@@ -6,7 +6,7 @@ require './lib/kubeclient'
 
 class PodTest < MiniTest::Test
 
-  def test_get_from_json
+  def test_get_from_json_v1
     json_response =  " { \"apiVersion\": \"v1beta1\",\n \"kind\": \"Pod\", \n \"id\": \"redis-master-pod\", \n  \"desiredState\": { \"manifest\": { \"version\": \"v1beta1\", \"id\": \"redis-master-pod\", \n
     \"containers\": [{ \"name\": \"redis-master\", \"image\": \"gurpartap/redis\", \"ports\": [{ \"name\": \"redis-server\", \"containerPort\": 6379 }] }] } }, \"labels\": { \"name\": \"redis\", \"role\": \"master\" } }"
 
@@ -21,4 +21,20 @@ class PodTest < MiniTest::Test
     assert_equal("redis-master",pod.desiredState.manifest.containers[0]['name'])
   end
 
+  def test_get_from_json_v3
+    json_response =   "{\n  \"kind\": \"Pod\",\n  \"apiVersion\": \"v1beta3\",\n  \"metadata\": {\n   \"name\": \"redis-master3\",\n  \"namespace\": \"default\",\n  \"selfLink\": \"/api/v1beta3/pods/redis-master3?namespace=default\",\n    \"uid\": \"a344023f-a23c-11e4-a36b-3c970e4a436a\",\n    \"resourceVersion\": \"9\",\n    \"creationTimestamp\": \"2015-01-22T15:43:24+02:00\",\n    \"labels\": {\n      \"name\": \"redis-master\"\n    }\n  },\n  \"spec\": {\n    \"volumes\": null,\n    \"containers\": [\n      {\n        \"name\": \"master\",\n        \"image\": \"dockerfile/redis\",\n        \"ports\": [\n          {\n            \"hostPort\": 6379,\n            \"containerPort\": 6379,\n            \"protocol\": \"TCP\"\n          }\n        ],\n        \"memory\": \"0\",\n        \"cpu\": \"100m\",\n        \"imagePullPolicy\": \"\"\n      },\n      {\n        \"name\": \"php-redis\",\n        \"image\": \"kubernetes/example-guestbook-php-redis\",\n        \"ports\": [\n          {\n            \"hostPort\": 8000,\n            \"containerPort\": 80,\n            \"protocol\": \"TCP\"\n          }\n        ],\n        \"memory\": \"50000000\",\n        \"cpu\": \"100m\",\n        \"imagePullPolicy\": \"\"\n      }\n    ],\n    \"restartPolicy\": {\n      \"always\": {}\n    },\n    \"dnsPolicy\": \"ClusterFirst\"\n  },\n  \"status\": {\n    \"phase\": \"Running\",\n    \"host\": \"127.0.0.1\",\n    \"podIP\": \"172.17.0.2\",\n    \"info\": {\n      \"master\": {\n        \"state\": {\n          \"running\": {\n            \"startedAt\": \"2015-01-22T13:43:29Z\"\n          }\n        },
+     \n  \"restartCount\": 0,\n   \"containerID\": \"docker://87458d9a12f9dc9a01b52c1eee5f09cf48939380271c0eaf31af298ce67b125e\",\n  \"image\": \"dockerfile/redis\"\n  },\n  \"net\": {\n  \"state\": {\n          \"running\": {\n            \"startedAt\": \"2015-01-22T13:43:27Z\"\n     }\n     },\n    \"restartCount\": 0,\n   \"containerID\": \"docker://3bb5ced1f831322d370f70b58137e1dd41216c2960b7a99394542b5230cbd259\",\n        \"podIP\": \"172.17.0.2\",\n        \"image\": \"kubernetes/pause:latest\"\n      },\n      \"php-redis\": {\n        \"state\": {\n          \"running\": {\n            \"startedAt\": \"2015-01-22T13:43:31Z\"\n          }\n        },\n        \"restartCount\": 0,\n        \"containerID\": \"docker://5f08685c0a7a5c974d438a52c6560d72bb0aae7e805d2a34302b9b460f1297c7\",\n        \"image\": \"kubernetes/example-guestbook-php-redis\"\n      }\n    }\n  }\n}"
+
+    stub_request(:get, /.*pods*/).
+        to_return(:body => json_response, :status => 200)
+
+    client = Kubeclient::Client.new 'http://localhost:8080/api/' , "v1beta3"
+    pod = client.get_pod "redis-master-pod"
+
+    assert_instance_of(Pod,pod)
+    assert_equal("redis-master3",pod.metadata.name)
+    assert_equal("dockerfile/redis",pod.spec.containers[0]["image"])
+
+  end
+
 end

data/test/replication_controller_test.rb

@@ -6,7 +6,7 @@ require 'json'
 
 class ReplicationControllerTest < MiniTest::Test
 
-  def test_get_from_json
+  def test_get_from_json_v1
     json_response = "{\n  \"kind\": \"ReplicationController\",\n  \"id\": \"frontendController\",\n  \"uid\": \"f4e5966c-8eb2-11e4-a6e7-3c970e4a436a\",\n  \"creationTimestamp\": \"2014-12-28T18:59:59+02:00\",\n  \"selfLink\": \"/api/v1beta1/replicationControllers/frontendController?namespace=default\",\n  \"resourceVersion\": 11,\n  \"apiVersion\": \"v1beta1\",\n  \"namespace\": \"default\",\n  \"desiredState\": {\n    \"replicas\": 3,\n    \"replicaSelector\": {\n      \"name\": \"frontend\"\n    },\n    \"podTemplate\": {\n      \"desiredState\": {\n        \"manifest\": {\n          \"version\": \"v1beta2\",\n          \"id\": \"\",\n          \"volumes\": null,\n          \"containers\": [\n            {\n              \"name\": \"php-redis\",\n              \"image\": \"brendanburns/php-redis\",\n              \"ports\": [\n                {\n                  \"hostPort\": 8000,\n                  \"containerPort\": 80,\n                  \"protocol\": \"TCP\"\n                }\n              ],\n              \"imagePullPolicy\": \"\"\n            }\n          ],\n          \"restartPolicy\": {\n            \"always\": {}\n          }\n        }\n      },\n      \"labels\": {\n        \"name\": \"frontend\"\n      }\n    }\n  },\n  \"currentState\": {\n    \"replicas\": 3,\n    \"podTemplate\": {\n      \"desiredState\": {\n        \"manifest\": {\n          \"version\": \"\",\n          \"id\": \"\",\n          \"volumes\": null,\n          \"containers\": null,\n          \"restartPolicy\": {}\n        }\n      }\n    }\n  },\n  \"labels\": {\n    \"name\": \"frontend\"\n  }\n}"
     stub_request(:get, /.*replicationControllers*/).
         to_return(:body => json_response, :status => 200)
@@ -24,4 +24,22 @@ class ReplicationControllerTest < MiniTest::Test
     #hence it can significantly impact the design of the client. to be revisited after beta v3 api is released.
     assert_equal("php-redis",rc.desiredState.podTemplate.desiredState.manifest.containers[0]['name'])
   end
+
+  def test_get_from_json_v3
+    json_response =  "{\n  \"kind\": \"ReplicationController\",\n  \"apiVersion\": \"v1beta3\",\n  \"metadata\": {\n    \"name\": \"guestbook-controller\",\n    \"namespace\": \"default\",\n    \"selfLink\": \"/api/v1beta3/replicationcontrollers/guestbook-controller?namespace=default\",\n    \"uid\": \"c71aa4c0-a240-11e4-a265-3c970e4a436a\",\n    \"resourceVersion\": \"8\",\n    \"creationTimestamp\": \"2015-01-22T16:13:02+02:00\",\n    \"labels\": {\n      \"name\": \"guestbook\"\n    }\n  },\n  \"spec\": {\n    \"replicas\": 3,\n    \"selector\": {\n      \"name\": \"guestbook\"\n    },\n    \"template\": {\n      \"metadata\": {\n        \"creationTimestamp\": null,\n        \"labels\": {\n          \"name\": \"guestbook\"\n        }\n      },\n      \"spec\": {\n        \"volumes\": null,\n        \"containers\": [\n          {\n            \"name\": \"guestbook\",\n            \"image\": \"kubernetes/guestbook\",\n            \"ports\": [\n              {\n                \"name\": \"http-server\",\n                \"containerPort\": 3000,\n                \"protocol\": \"TCP\"\n              }\n            ],\n            \"memory\": \"0\",\n            \"cpu\": \"0m\",\n            \"imagePullPolicy\": \"\"\n          }\n        ],\n        \"restartPolicy\": {\n          \"always\": {}\n        },\n        \"dnsPolicy\": \"ClusterFirst\"\n      }\n    }\n  },\n  \"status\": {\n    \"replicas\": 3\n  }\n}"
+
+    stub_request(:get, /.*replicationcontrollers*/).
+        to_return(:body => json_response, :status => 200)
+
+    client = Kubeclient::Client.new 'http://localhost:8080/api/' , "v1beta3"
+    rc = client.get_replication_controller "frontendController"
+
+    assert_instance_of(ReplicationController,rc)
+    assert_equal("guestbook-controller",rc.metadata.name)
+    assert_equal("c71aa4c0-a240-11e4-a265-3c970e4a436a",rc.metadata.uid)
+    assert_equal("default",rc.metadata.namespace)
+    assert_equal(3,rc.spec.replicas)
+    assert_equal("guestbook",rc.spec.selector.name)
+  end
+
 end

data/test/service_test.rb

@@ -5,8 +5,7 @@ require 'json'
 require './lib/kubeclient'
 
 class ServiceTest < MiniTest::Test
-  def test_get_from_json
-    # creation of the entity from json as if it was read from the server REST api
+  def test_get_from_json_v1
     mock = Service.new({"kind"=>"Service", "id"=>"redis-service", "uid"=>"fb01a69c-8ae2-11e4-acc5-3c970e4a436a", "namespace"=>"default", "port"=>80, "protocol"=>"TCP", "labels"=>{"component"=>"apiserver", "provider"=>"kubernetes"}, "selector"=>nil, "creation_timestamp"=>"2014-12-23T22:33:40+02:00", "self_link"=>"/api/v1beta1/services/kubernetes-ro?namespace=default", "resource_version"=>4, "api_version"=>"v1beta1", "container_port"=>0, "portal_ip"=>"10.0.0.54"})
 
     assert_equal 'redis-service', mock.id
@@ -31,7 +30,7 @@ class ServiceTest < MiniTest::Test
   end
 
 
-  def test_conversion_from_json
+  def test_conversion_from_json_v1
     json_response = "{\n  \"kind\": \"Service\",\n  \"id\": \"redisslave\",\n  \"uid\": \"6a022e83-8ea7-11e4-a6e7-3c970e4a436a\",\n  \"creationTimestamp\": \"2014-12-28T17:37:21+02:00\",\n  \"selfLink\": \"/api/v1beta1/services/redisslave?namespace=default\",\n  \"resourceVersion\": 8,\n  \"apiVersion\": \"v1beta1\",\n  \"namespace\": \"default\",\n  \"port\": 10001,\n  \"protocol\": \"TCP\",\n  \"labels\": {\n    \"name\": \"redisslave\"\n  },\n  \"selector\": {\n    \"name\": \"redisslave\"\n  },\n  \"containerPort\": 6379,\n  \"portalIP\": \"10.0.0.248\"\n}"
 
     stub_request(:get, /.*services*/).
@@ -55,6 +54,31 @@ class ServiceTest < MiniTest::Test
 
   end
 
+  def test_conversion_from_json_v3
+    json_response =  "{\n  \"kind\": \"Service\",\n  \"apiVersion\": \"v1beta3\",\n  \"metadata\": {\n    \"name\": \"kubernetes-ro\",\n    \"namespace\": \"default\",\n    \"selfLink\": \"/api/v1beta3/services/kubernetes-ro?namespace=default\",\n    \"uid\": \"ffb153db-a230-11e4-a36b-3c970e4a436a\",\n    \"resourceVersion\": \"4\",\n    \"creationTimestamp\": \"2015-01-22T14:20:05+02:00\",\n    \"labels\": {\n      \"component\": \"apiserver\",\n      \"provider\": \"kubernetes\"\n    }\n  },\n  \"spec\": {\n    \"port\": 80,\n    \"protocol\": \"TCP\",\n    \"selector\": null,\n    \"portalIP\": \"10.0.0.154\",\n    \"containerPort\": 0,\n    \"sessionAffinity\": \"None\"\n  },\n  \"status\": {}\n}"
+
+
+    stub_request(:get, /.*services*/).
+        to_return(:body => json_response, :status => 200)
+
+    client = Kubeclient::Client.new 'http://localhost:8080/api/' , "v1beta3"
+    service = client.get_service "redisslave"
+
+    assert_instance_of(Service,service)
+    #checking that creationTimestamp was renamed properly
+    assert_equal("2015-01-22T14:20:05+02:00",service.metadata.creationTimestamp)
+    assert_equal("ffb153db-a230-11e4-a36b-3c970e4a436a",service.metadata.uid)
+    assert_equal("kubernetes-ro",service.metadata.name)
+    assert_equal("4",service.metadata.resourceVersion)
+    assert_equal("v1beta3",service.apiVersion)
+    assert_equal("10.0.0.154",service.spec.portalIP)
+    assert_equal(0,service.spec.containerPort)
+    assert_equal("TCP",service.spec.protocol)
+    assert_equal(80,service.spec.port)
+    assert_equal("default",service.metadata.namespace)
+
+  end
+
   def test_delete_service
     our_service = Service.new
     our_service.id = 'redis-service'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kubeclient
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - Alissa Bonas