kubeclient 2.5.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d647693b6947c9d717f0b19dad1c1cadc46f14b7
-  data.tar.gz: 1355734798902a5b0f890568df9276cc390205b7
+  metadata.gz: e9aaeb2002708298a57d829ccce3530a4233de62
+  data.tar.gz: 4343990defde5ef36719ccbf02936b92e7e1be5c
 SHA512:
-  metadata.gz: d0f30f0903cbb179aee65b8a5e28f743e45ea6500752df248694f4ae57aaa46b98a6561638a83c915ce20cf0787159457ad85a2d7ac5573eec6913d83fe0989e
-  data.tar.gz: 6a696571fe8281b2dad5d6f01f429c7d02a51913272a711dd315bbbd27f9f291e41ab60a89d8dd92a0a96f7a91931ddbedb880c691b653f6498d44480d5d0268
+  metadata.gz: 928f8df41783e2eb13c65536de2ad3270f3ed3fcc95459d25fcb21a66a6e86b0f279a9c238cddb7196dc82bd7c9cc7dd42a778f208ee56397e149a4c0f048f3c
+  data.tar.gz: 9a541d45aba922c4ab24196bd3d0cb755a46ae5bd276436510fa66e60cdc6c60056eba4501152036751ec5cd8ec3ec8c0d254687c54b6ba532ac18812634a06b

data/.rubocop.yml

@@ -1,9 +1,10 @@
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.2 # Oldest version kubeclient supports
 MethodLength:
   Enabled: false
 ClassLength:
   Enabled: false
-Documentation:
-  Enabled: false
 Metrics/AbcSize:
   Enabled: false
 Metrics/LineLength:
@@ -13,7 +14,14 @@ Metrics/ParameterLists:
   CountKeywordArgs: false
 Metrics/CyclomaticComplexity:
   Max: 8
-Style/FileName:
-  Exclude: [Gemfile*]
-Style/SignalException:
+Metrics/ModuleLength:
   Enabled: false
+Style/MethodCallWithArgsParentheses:
+  Enabled: true
+  IgnoredMethods: [require, raise, include, attr_reader, refute, assert]
+  Exclude: [Gemfile, Rakefile, kubeclient.gemspec]
+Security/MarshalLoad:
+  Exclude: [test/**/*]
+Style/MethodCallWithArgsParentheses:
+  IgnoredMethods:
+  - require_relative

data/.travis.yml

@@ -1,20 +1,12 @@
 language: ruby
 rvm:
-  - "2.0"
-  - "2.1"
   - "2.2"
   - "2.3.0"
-gemfile:
-  - Gemfile
-  - Gemfile-rest-client-1.8.rb
+  - "2.4.0"
+  - "2.5.0"
 sudo: false
 cache: bundler
 script: bundle exec rake $TASK
 env:
  - TASK=test
  - TASK=rubocop
-matrix:
-  exclude:
-    # No point running rubocop with old rest-client
-    - gemfile: Gemfile-rest-client-1.8.rb
-      env: TASK=rubocop

data/CHANGELOG.md

@@ -3,11 +3,30 @@
 Notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 
-## 2.5.2 - 2018-02-04
+## 3.0.0 - 2018-02-01
+### Removed
+- Dropped entity classes (`Kubeclient::Pod` etc.), only `Kubeclient::Resource` exists now (#292, #288).
+- Ruby 2.0, 2.1 no longer supported (#253, #291).
+
 ### Fixed
 - Watch results are now `RecursiveOpenStruct` inside arrays too (#279).
 - Fixed watch `.finish` sometimes caused `Errno::EBADF` exception from the reading loop (#280).
-- Easing dependency version (#287, #301)  
+- Added missing singular `get_security_context_constraint`, fixed `get_security_context_constraints` to mean plural (#261).
+- Fixed `@http_proxy_uri` undefined warning (#261).
+- Documentation fixes & improvements (#225, #229, #243, #296).
+
+### Added
+- `delete_options:` parameter to `delete_*` methods, useful for cascade delete (#267).
+- `as: :raw` option for watch (#285).
+- Now raises `Kubeclient::HttpError`.  Rescuing `KubeException` still works but is deprecated. (#195, #288)
+  - 404 error raise `Kubeclient::ResourceNotFoundError`, a subclass of `HttpError` (#233).
+- Include request info in exception message (#221).
+- Ruby 2.4 and 2.5 are now supported & tested (#247, #295).
+
+### Changed
+- `Kubeclient::Config#context(nonexistent_context_name)` raises `KeyError` instead of `RuntimeError`.
+- `update_*`, `delete_*`, `patch_*` now all return `RecursiveOpenStruct` consistently (#290).
+- Many dependencies bumped (#204, #231, #253, #269).
 
 ## 2.5.1 - 2017-10-12
 No changes since 2.5.0, fixed packaging mistake.

data/README.md

@@ -6,8 +6,9 @@
 [![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, secrets, services, replication controllers, namespaces, resource quotas, limit ranges, endpoints, persistent volumes, persistent volume claims, component statuses and service accounts.
+The client supports GET, POST, PUT, DELETE on all the entities available in kubernetes in both the core and group apis.
 The client currently supports Kubernetes REST api version v1.
+To learn more about groups and versions in kubernetes refer to [k8s docs](https://kubernetes.io/docs/api/)
 
 ## Installation
 
@@ -19,23 +20,28 @@ gem 'kubeclient'
 
 And then execute:
 
-    $ bundle
+```Bash
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install kubeclient
+```Bash
+gem install kubeclient
+```
 
 ## Usage
 
 Initialize the client:
+
 ```ruby
-client = Kubeclient::Client.new 'http://localhost:8080/api/' , "v1"
+client = Kubeclient::Client.new('http://localhost:8080/api/', "v1")
 ```
 
 Or without specifying version (it will be set by default to "v1")
 
 ```ruby
-client = Kubeclient::Client.new 'http://localhost:8080/api/'
+client = Kubeclient::Client.new('http://localhost:8080/api/')
 ```
 
 For A Group Api:
@@ -48,7 +54,7 @@ Another option is to initialize the client with URI object:
 
 ```ruby
 uri = URI::HTTP.build(host: "somehostname", port: 8080)
-client = Kubeclient::Client.new uri
+client = Kubeclient::Client.new(uri)
 ```
 
 ### SSL
@@ -62,8 +68,9 @@ ssl_options = {
   ca_file:     '/path/to/ca.crt',
   verify_ssl:  OpenSSL::SSL::VERIFY_PEER
 }
-client = Kubeclient::Client.new 'https://localhost:8443/api/' , "v1",
-                                ssl_options: ssl_options
+client = Kubeclient::Client.new(
+  'https://localhost:8443/api/', "v1", ssl_options: ssl_options
+)
 ```
 
 As an alternative to the `ca_file` it's possible to use the `cert_store`:
@@ -75,16 +82,18 @@ ssl_options = {
   cert_store: cert_store,
   verify_ssl: OpenSSL::SSL::VERIFY_PEER
 }
-client = Kubeclient::Client.new 'https://localhost:8443/api/' , "v1",
-                                ssl_options: ssl_options
+client = Kubeclient::Client.new(
+  'https://localhost:8443/api/', "v1", ssl_options: ssl_options
+)
 ```
 
 For testing and development purpose you can disable the ssl check with:
 
 ```ruby
 ssl_options = { verify_ssl: OpenSSL::SSL::VERIFY_NONE }
-client = Kubeclient::Client.new 'https://localhost:8443/api/' , 'v1',
-                                ssl_options: ssl_options
+client = Kubeclient::Client.new(
+  'https://localhost:8443/api/', 'v1', ssl_options: ssl_options
+)
 ```
 
 ### Authentication
@@ -98,8 +107,9 @@ auth_options = {
   username: 'username',
   password: 'password'
 }
-client = Kubeclient::Client.new 'https://localhost:8443/api/' , 'v1',
-                                auth_options: auth_options
+client = Kubeclient::Client.new(
+  'https://localhost:8443/api/', 'v1', auth_options: auth_options
+)
 ```
 
 or
@@ -108,8 +118,9 @@ or
 auth_options = {
   bearer_token: 'MDExMWJkMjItOWY1Ny00OGM5LWJlNDEtMjBiMzgxODkxYzYz'
 }
-client = Kubeclient::Client.new 'https://localhost:8443/api/' , 'v1',
-                                auth_options: auth_options
+client = Kubeclient::Client.new(
+  'https://localhost:8443/api/', 'v1', auth_options: auth_options
+)
 ```
 
 or
@@ -118,8 +129,9 @@ or
 auth_options = {
   bearer_token_file: '/path/to/token_file'
 }
-client = Kubeclient::Client.new 'https://localhost:8443/api/' , 'v1',
-                                auth_options: auth_options
+client = Kubeclient::Client.new(
+  'https://localhost:8443/api/', 'v1', auth_options: auth_options
+)
 ```
 
 If you are running your app using kubeclient inside a Kubernetes cluster, then you can have a bearer token file
@@ -133,15 +145,16 @@ for more details). For example:
 auth_options = {
   bearer_token_file: '/var/run/secrets/kubernetes.io/serviceaccount/token'
 }
-client = Kubeclient::Client.new 'https://localhost:8443/api/' , 'v1',
-                                auth_options: auth_options
+client = Kubeclient::Client.new(
+  'https://localhost:8443/api/', 'v1', auth_options: auth_options
+)
 ```
 
-You can find information about token in [this guide](http://kubernetes.io/docs/user-guide/accessing-the-cluster/) and in [this reference](http://kubernetes.io/docs/admin/authentication/).
+You can find information about tokens in [this guide](http://kubernetes.io/docs/user-guide/accessing-the-cluster/) and in [this reference](http://kubernetes.io/docs/admin/authentication/).
 
 ### Non-blocking IO
 
-You can also use kubeclient with non-blocking sockets such as Celluloid::IO, see [here](https://github.com/httprb/http/wiki/Parallel-requests-with-Celluloid%3A%3AIO) 
+You can also use kubeclient with non-blocking sockets such as Celluloid::IO, see [here](https://github.com/httprb/http/wiki/Parallel-requests-with-Celluloid%3A%3AIO)
 for details. For example:
 
 ```ruby
@@ -150,8 +163,9 @@ socket_options = {
   socket_class: Celluloid::IO::TCPSocket,
   ssl_socket_class: Celluloid::IO::SSLSocket
 }
-client = Kubeclient::Client.new 'https://localhost:8443/api/' , 'v1',
-                                socket_options: socket_options
+client = Kubeclient::Client.new(
+  'https://localhost:8443/api/', 'v1', socket_options: socket_options
+)
 ```
 
 This affects only `.watch_*` sockets, not one-off actions like `.get_*`, `.delete_*` etc.
@@ -162,8 +176,9 @@ You can also use kubeclient with an http proxy server such as tinyproxy. It can
 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)
+client = Kubeclient::Client.new(
+  'https://localhost:8443/api/', http_proxy_uri: proxy_uri
+)
 ```
 
 
@@ -193,13 +208,15 @@ If you want ruby-independent behavior, always specify `:open`.
 Discovery from the kube-apiserver is done lazily on method calls so it would not change behavior.
 
 It can also  be done explicitly:
-```
+
+```ruby
 client = Kubeclient::Client.new('http://localhost:8080/api', 'v1')
 client.discover
 ```
 
 It is possible to check the status of discovery
-```
+
+```ruby
 unless client.discovered
   client.discover
 end
@@ -208,6 +225,7 @@ end
 ### Kubeclient::Config
 
 If you've been using `kubectl` and have a `.kube/config` file, you can auto-populate a config object using `Kubeclient::Config`:
+
 ```ruby
 config = Kubeclient::Config.read('/path/to/.kube/config')
 ```
@@ -216,21 +234,22 @@ config = Kubeclient::Config.read('/path/to/.kube/config')
 
 ```
 Kubeclient::Client.new(
-	config.context.api_endpoint,
+  config.context.api_endpoint,
     config.context.api_version,
     {
-    	ssl_options: config.context.ssl_options,
-    	auth_options: config.context.auth_options
+      ssl_options: config.context.ssl_options,
+      auth_options: config.context.auth_options
     }
 )
 ```
 
 You can also load your JSONified config in from an ENV variable (e.g. `KUBE_CONFIG`) like so:
 
-```
+```ruby
 Kubeclient::Config.new(JSON.parse(ENV['KUBE_CONFIG']), nil)
 ```
-###Supported kubernetes versions
+
+### Supported kubernetes versions
 
 For 1.1 only the core api v1 is supported, all api groups are supported in later versions.
 
@@ -256,6 +275,7 @@ pods = client.get_pods(label_selector: 'name=redis-master')
 ```
 
 You can specify multiple labels (that option will return entities which have both labels:
+
 ```ruby
 pods = client.get_pods(label_selector: 'name=redis-master,app=redis')
 ```
@@ -289,8 +309,23 @@ node = client.get_node "127.0.0.1", as: :raw
 For example: `delete_pod "pod name"` , `delete_replication_controller "rc name"`, `delete_node "node name"`, `delete_secret "secret name"`
 
 Input parameter - name (string) specifying service name, pod name, replication controller name.
+
+```ruby
+deleted = client.delete_service("redis-service")
+```
+
+If you want to cascade delete, for example a deployment, you can use the `delete_options` parameter.
+
 ```ruby
-client.delete_service "redis-service"
+deployment_name = 'redis-deployment'
+namespace = 'default'
+delete_options = Kubeclient::Resource.new(
+    apiVersion: 'meta/v1',
+    gracePeriodSeconds: 0,
+    kind: 'DeleteOptions',
+    propagationPolicy: 'Foreground' # Orphan, Foreground, or Background
+)
+client.delete_deployment(deployment_name, namespace, delete_options: delete_options)
 ```
 
 #### Create an entity
@@ -301,21 +336,22 @@ Input parameter - object of type `Service`, `Pod`, `ReplicationController`.
 The below example is for v1
 
 ```ruby
-service = Service.new
+service = Kubeclient::Resource.new
 service.metadata = {}
 service.metadata.name = "redis-master"
 service.metadata.namespace = 'staging'
 service.spec = {}
-service.spec.ports = [{ 'port' => 6379,
-                                'targetPort' => 'redis-server'
-                              }]
+service.spec.ports = [{
+  'port' => 6379,
+  'targetPort' => 'redis-server'
+}]
 service.spec.selector = {}
 service.spec.selector.name = "redis"
 service.spec.selector.role = "master"
 service.metadata.labels = {}
 service.metadata.labels.app = 'redis'
 service.metadata.labels.role = 'slave'
-client.create_service service`
+client.create_service(service)
 ```
 
 #### Update an entity
@@ -326,7 +362,7 @@ Input parameter - object of type `Pod`, `Service`, `ReplicationController` etc.
 The below example is for v1
 
 ```ruby
-client.update_service service1
+updated = client.update_service(service1)
 ```
 
 #### Patch an entity (by name)
@@ -339,7 +375,7 @@ The PATCH request should include the namespace name, except for nodes and namesp
 The below example is for v1
 
 ```ruby
-client.patch_pod "docker-registry", {:metadata => {:annotations => {:key => 'value'}}}, "default"
+patched = client.patch_pod("docker-registry", {metadata: {annotations: {key: 'value'}}}, "default")
 ```
 
 #### Get all entities of all types : all_entities
@@ -366,6 +402,8 @@ It is possible to interrupt the watcher from another thread with:
 watcher.finish
 ```
 
+Pass `as: :raw` to `watch_*` get raw replies.
+
 #### Watch events for a particular object
 You can use the `field_selector` option as part of the watch methods.
 
@@ -381,14 +419,14 @@ You can get a complete URL for connecting a kubernetes entity via the proxy.
 
 ```ruby
 client.proxy_url('service', 'srvname', 'srvportname', 'ns')
- => "https://localhost.localdomain:8443/api/v1/proxy/namespaces/ns/services/srvname:srvportname"
+# => "https://localhost.localdomain:8443/api/v1/proxy/namespaces/ns/services/srvname:srvportname"
 ```
 
 Note the third parameter, port, is a port name for services and an integer for pods:
 
 ```ruby
 client.proxy_url('pod', 'podname', 5001, 'ns')
- => "https://localhost.localdomain:8443/api/v1/namespaces/ns/pods/podname:5001/proxy"
+# => "https://localhost.localdomain:8443/api/v1/namespaces/ns/pods/podname:5001/proxy"
 ```
 
 #### Get the logs of a pod
@@ -397,14 +435,14 @@ namespace where the pod is running:
 
 ```ruby
 client.get_pod_log('pod-name', 'default')
- => "Running...\nRunning...\nRunning...\n"
+# => "Running...\nRunning...\nRunning...\n"
 ```
 
 If that pod has more than one container, you must specify the container:
 
 ```ruby
 client.get_pod_log('pod-name', 'default', container: 'ruby')
- => "..."
+# => "..."
 ```
 
 If a container in a pod terminates, a new container is started, and you want to
@@ -412,7 +450,7 @@ retrieve the logs of the dead container, you can pass in the `:previous` option:
 
 ```ruby
 client.get_pod_log('pod-name', 'default', previous: true)
- => "..."
+# => "..."
 ```
 
 You can also watch the logs of a pod to get a stream of data:
@@ -430,21 +468,49 @@ Input parameter - template (hash)
 Besides its metadata, the template should include a list of objects to be processed and a list of parameters
 to be substituted. Note that for a required parameter that does not provide a generated value, you must supply a value.
 
+##### Note: This functionality is not supported by K8s at this moment. See the following [issue](https://github.com/kubernetes/kubernetes/issues/23896)
+
 ```ruby
 client.process_template template
 ```
 
 ## Upgrading
 
+See [CHANGELOG.md](CHANGELOG.md) for full changelog.
+
+#### past version 3.0
+
+Ruby versions < 2.2 are no longer supported
+
+Specific entity classes mentioned in [past version 1.2.0](#past_version_1.2.0) have been dropped.
+Return values and expected classes are always Kubeclient::Resource.
+Checking the type of a resource can be done using:
+```
+> pod.kind
+=> "Pod"
+```
+
+update_* delete_* and patch_* now return a RecursiveOpenStruct like the get_* methods
+
+The gem raises Kubeclient::HttpError or subclasses now. Catching KubeException still works but is deprecated.
+
+`Kubeclient::Config#context` raises KeyError instead of RuntimeError for non-existent context name.
+
+<a name="past_version_1.2.0">
+
 #### past version 1.2.0
 Replace Specific Entity class references:
+
 ```ruby
 Kubeclient::Service
 ```
+
 with the generic
+
 ```ruby
 Kubeclient::Resource.new
 ```
+
 Where ever possible.
 
 ## Contributing