ruby-kubernetes-controller 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d55b9567e58b5914dab1151b68240f3262111e0274507d2c7cd77699dad0edf
-  data.tar.gz: 787f41c21436a319ff1001b8712c354f3356c487a15916ebd08ba2814d4ac483
+  metadata.gz: ae9bccbe5b323b1c7319de8370b94439cd95627c785e2bda8ba359d6f27b3df0
+  data.tar.gz: 6a5b3923bb1f538942c4d61355957ff31ab9ea7048c379773d4df77b1a97fe26
 SHA512:
-  metadata.gz: bffd65b4bc59d2c729d617c309726d5708b9621a4bd4ea30a90fe7bde5c3ad34143c717057ec4bf7e36986662f1c46f4de381a7989f28e0fedf4819cf001b12a
-  data.tar.gz: bf88f4d6de9967c89d8620fe9a2e81b7215f5251c7dedc14c83782ae6a97b3c738166d6d23e714ecad280fc8285daef66e8b5a27c42a37ad9c0108fb1abde2eb
+  metadata.gz: b82a2e8b4e416deeeeec55a9adbba752c9f555dc2c72cba9896d1af82f0ee6356ba6c38472f56b5344b4801d8dc1cc16747908eba3ec8110cdc9182ecf3f2a8c
+  data.tar.gz: ddee35da7ff08689047c2faa4a9b98a8b83ac75356e67216304832feffee5d3d614efb20660d293838f70019fae61f177330108c299b5764d0be08098ed9e340

data/Documentation/DOCUMENTATION.md

@@ -1767,4 +1767,185 @@ Before beginning, you must generate a bearer token for the Ruby Kubernetes Contr
     puts yaml_client.delete_job(namespace, job_name, yaml_file_path) # Returns JSON
 ```
 
+#### Create cronjob
+* Create new cronjob
+```ruby
+    require 'ruby-kubernetes-controller'
+    
+    endpoint = "localhost"
+    bearer_token = "token"
+    ssl = false
+    
+    # With JSON
+    json_client = ::RubyKubernetesController::Client.new(endpoint, bearer_token, ssl, yaml = false)
+    namespace = "default"
+    json_config = 
+    '{
+        "kind": "CronJob",
+        "apiVersion": "batch/v1beta1",
+         ... 
+     }'   
+    
+    puts json_client.create_new_cronjob(namespace, json_config) # Returns JSON
+    
+    # With YAML
+    yaml_client = ::RubyKubernetesController::Client.new(endpoint, bearer_token, ssl, yaml = true)
+    namespace = "default"
+    yaml_file_path = 'path/to/file.yaml'
+    
+    puts yaml_client.create_new_cronjob(namespace, yaml_file_path) # Returns JSON
+```
+
+#### Get cronjobs
+* List all cronjobs
+```ruby
+    require 'ruby-kubernetes-controller'
+    
+    endpoint = "localhost"
+    bearer_token = "token"
+    ssl = false
+    
+    client = ::RubyKubernetesController::Client.new(endpoint, bearer_token, ssl)
+    
+    puts client.get_all_cronjobs # Returns JSON
+```
+
+#### Get Namespaced cronjobs
+* List all existing cronjobs in Namespace
+```ruby
+    require 'ruby-kubernetes-controller'
+    
+    endpoint = "localhost"
+    bearer_token = "token"
+    ssl = false
+    
+    client = ::RubyKubernetesController::Client.new(endpoint, bearer_token, ssl)
+    
+    namespace = "default"
+    
+    puts client.get_all_namespaced_cronjobs(namespace) # Returns JSON
+```
+
+#### Get Single Namespaced cronjob
+* Get details for single cronjob in Namespace
+```ruby
+    require 'ruby-kubernetes-controller'
+    
+    endpoint = "localhost"
+    bearer_token = "token"
+    ssl = false
+    
+    client = ::RubyKubernetesController::Client.new(endpoint, bearer_token, ssl)
+    
+    namespace = "default"
+    cronjob_name = "cronjob"
+    
+    puts client.get_single_namespaced_cronjob(namespace, cronjob_name) # Returns JSON
+```
+
+#### Update cronjob
+* Update existing cronjob in Namespace
+```ruby
+    require 'ruby-kubernetes-controller'
+    
+    endpoint = "localhost"
+    bearer_token = "token"
+    ssl = false
+    
+    # With JSON
+    json_client = ::RubyKubernetesController::Client.new(endpoint, bearer_token, ssl, yaml = false)
+    namespace = "default"
+    cronjob_name = "cronjob"
+    json_update = 
+    '{
+        "kind": "CronJob",
+        "apiVersion": "batch/v1beta1",
+         ... 
+     }'    
+    
+    puts json_client.update_namespaced_cronjob(namespace, cronjob_name, json_update) # Returns JSON
+    
+    # With YAML
+    yaml_client = ::RubyKubernetesController::Client.new(endpoint, bearer_token, ssl, yaml = true)
+    namespace = "default"
+    cronjob_name = "cronjob"
+    yaml_file_path = 'path/to/file.yaml'
+    
+    puts yaml_client.update_namespaced_cronjob(namespace, cronjob_name, yaml_file_path) # Returns JSON
+```
+
+#### Patch cronjob
+* Patch existing cronjob
+* Patch Format documentation available at: http://jsonpatch.com/
+```ruby
+    require 'ruby-kubernetes-controller'
+    
+    endpoint = "localhost"
+    bearer_token = "token"
+    ssl = false
+    
+    client = ::RubyKubernetesController::Client.new(endpoint, bearer_token, ssl)
+    
+    namespace = "default"
+    cronjob_name = "cronjob"
+    patch = 
+    '[
+      { "op": "replace", "path": "/baz", "value": "boo" },
+      { "op": "add", "path": "/hello", "value": ["world"] },
+      { "op": "remove", "path": "/foo" }
+    ]'    
+    
+    puts client.patch_cronjob(namespace, cronjob_name, patch) # Returns JSON
+```
+
+#### Delete cronjob
+* Delete existing cronjob
+* Delete options documentation available at: https://kubernetes.io/docs/reference/federation/v1/definitions/#_v1_deleteoptions
+```ruby
+    require 'ruby-kubernetes-controller'
+    
+    endpoint = "localhost"
+    bearer_token = "token"
+    ssl = false
+    
+    # With JSON
+    json_client = ::RubyKubernetesController::Client.new(endpoint, bearer_token, ssl, yaml = false)
+    namespace = "default"
+    cronjob_name = "cronjob"
+    json_options = 
+    '{
+        "kind": "CronJob",
+        "apiVersion": "batch/v1beta1",
+         ... 
+     }'    
+    
+    puts json_client.delete_cronjob(namespace, cronjob_name, json_options) # Returns JSON
+    
+    # With YAML
+    yaml_client = ::RubyKubernetesController::Client.new(endpoint, bearer_token, ssl, yaml = true)
+    namespace = "default"
+    cronjob_name = "cronjob"
+    yaml_file_path = 'path/to/file.yaml'
+    
+    puts yaml_client.delete_cronjob(namespace, cronjob_name, yaml_file_path) # Returns JSON
+```
+
+#### Triggering a cronjob
+* Trigger an existing cronjob in Namespace
+```ruby
+    require 'ruby-kubernetes-controller'
+    
+    endpoint = "localhost"
+    bearer_token = "token"
+    ssl = false
+    
+    # With JSON
+    json_client = ::RubyKubernetesController::Client.new(endpoint, bearer_token, ssl, yaml = false)
+    namespace = "default"
+    cronjob_name = "cronjob"
+    restart_policy = "Never"
+    
+    puts json_client.trigger_cronjob(namespace, cronjob_name, restart_policy) # Returns JSON
+```
+
 [SERVICEACCOUNT]: https://github.com/IBM/ruby-kubernetes-controller/blob/master/Documentation/serviceaccount.yaml

data/lib/ruby-kubernetes-controller/client.rb

@@ -16,6 +16,8 @@ require_relative 'configmaps'
 require_relative 'persistentvolumes'
 require_relative 'persistentvolumeclaims'
 require_relative 'jobs'
+require_relative 'cronjob'
+require_relative 'utilities'
 
 # Part of the RubyKubernetesController module
 module RubyKubernetesController
@@ -36,6 +38,8 @@ module RubyKubernetesController
     include PersistentVolumes
     include PersistentVolumeClaims
     include Jobs
+    include CronJobs
+    include Utilities
 
     # Constructor
     def initialize(endpoint, bearer_token, ssl = true, yaml = false)

data/lib/ruby-kubernetes-controller/cronjob.rb

@@ -0,0 +1,181 @@
+require 'net/http'
+require 'uri'
+require 'openssl'
+require 'json'
+
+require_relative 'generic'
+
+module CronJobs
+    include Generic
+    
+    # Create new CronJob
+    def create_new_cronjob(namespace, config)
+        extension = "/apis/batch/v1beta1/namespaces/#{namespace}/cronjobs"
+        
+        uri = prepareURI(@endpoint, extension)
+        
+        request = prepareGenericRequest(uri, @bearer_token,  "POST")
+        request.content_type = "application/json"
+        
+        if @yaml
+            request.body = yaml_file_to_json(config)
+            else
+            request.body = config
+        end
+        
+        req_options = prepareGenericRequestOptions(@ssl, uri)
+        
+        begin
+            response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+                http.request(request)
+            end
+            return response.body
+            
+            rescue Errno::ECONNREFUSED
+            raise "Connection for host #{uri.hostname} refused"
+        end
+    end
+    
+    # Get all CronJobs
+    def get_all_cronjobs
+        extension = "/apis/batch/v1beta1/cronjobs"
+        
+        uri = prepareURI(@endpoint, extension)
+        
+        request = prepareGenericRequest(uri, @bearer_token, "GET")
+        
+        req_options = prepareGenericRequestOptions(@ssl, uri)
+        
+        begin
+            response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+                http.request(request)
+            end
+            return response.body
+            
+            rescue Errno::ECONNREFUSED
+            raise "Connection for host #{uri.hostname} refused"
+        end
+    end
+    
+    # Get all existing CronJobs in Namespace
+    def get_all_namespaced_cronjobs(namespace)
+        extension = "/apis/batch/v1beta1/namespaces/#{namespace}/cronjobs"
+        
+        uri = prepareURI(@endpoint, extension)
+        
+        request = prepareGenericRequest(uri, @bearer_token, "GET")
+        
+        req_options = prepareGenericRequestOptions(@ssl, uri)
+        
+        begin
+            response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+                http.request(request)
+            end
+            return response.body
+            
+            rescue Errno::ECONNREFUSED
+            raise "Connection for host #{uri.hostname} refused"
+        end
+    end
+    
+    # Get single CronJob in Namespace
+    def get_single_namespaced_cronjob(namespace, cronjob_name)
+        extension = "/apis/batch/v1beta1/namespaces/#{namespace}/cronjobs/#{cronjob_name}"
+        
+        uri = prepareURI(@endpoint, extension)
+        
+        request = prepareGenericRequest(uri, @bearer_token, "GET")
+        
+        req_options = prepareGenericRequestOptions(@ssl, uri)
+        
+        begin
+            response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+                http.request(request)
+            end
+            return response.body
+            rescue Errno::ECONNREFUSED
+            raise "Connection for host #{uri.hostname} refused"
+        end
+    end
+    
+    # Update existing CronJob in Namespace
+    def update_namespaced_cronjob(namespace, cronjob_name, update)
+        extension = "/apis/batch/v1beta1/namespaces/#{namespace}/cronjobs/#{cronjob_name}"
+        
+        uri = prepareURI(@endpoint, extension)
+        
+        request = prepareGenericRequest(uri, @bearer_token, "PUT")
+        request.content_type = "application/json"
+        
+        if @yaml
+            request.body = yaml_file_to_json(update)
+            else
+            request.body = update
+        end
+        
+        req_options = prepareGenericRequestOptions(@ssl, uri)
+        
+        begin
+            response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+                http.request(request)
+            end
+            return response.body
+            
+            rescue Errno::ECONNREFUSED
+            raise "Connection for host #{uri.hostname} refused"
+        end
+        
+    end
+    
+    # Patch existing CronJob in Namespace
+    def patch_cronjob(namespace, cronjob_name, patch)
+        extension = "/apis/batch/v1beta1/namespaces/#{namespace}/cronjobs/#{cronjob_name}"
+        
+        uri = prepareURI(@endpoint, extension)
+        
+        request = prepareGenericRequest(uri, @bearer_token, "PATCH")
+        request.content_type = "application/json-patch+json"
+        
+        request.body = patch
+        
+        req_options = prepareGenericRequestOptions(@ssl, uri)
+        
+        begin
+            response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+                http.request(request)
+            end
+            return response.body
+            rescue Errno::ECONNREFUSED
+            raise "Connection for host #{uri.hostname} refused"
+        end
+    end
+    
+    # Delete existing Job in Namespace
+    def delete_cronjob(namespace, cronjob_name, options = '')
+        extension = "apis/batch/v1beta1/namespaces/#{namespace}/cronjobs/#{cronjob_name}"
+        
+        uri = prepareURI(@endpoint, extension)
+        
+        request = prepareGenericRequest(uri, @bearer_token, "DELETE")
+        request.content_type = "application/json"
+        
+        if @yaml
+            request.body = yaml_file_to_json(options)
+            else
+            request.body = options
+        end
+        
+        req_options = prepareGenericRequestOptions(@ssl, uri)
+        
+        begin
+            response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+                http.request(request)
+            end
+            return response.body
+            
+            rescue Errno::ECONNREFUSED
+            raise "Connection for host #{uri.hostname} refused"
+        end
+    end
+    
+end

data/lib/ruby-kubernetes-controller/utilities.rb

@@ -0,0 +1,58 @@
+require 'net/http'
+require 'uri'
+require 'openssl'
+require 'json'
+
+require_relative 'generic'
+require_relative 'namespaces'
+require_relative 'ingresses'
+require_relative 'nodes'
+require_relative 'endpoints'
+require_relative 'pods'
+require_relative 'services'
+require_relative 'deployments'
+require_relative 'replicasets'
+require_relative 'configmaps'
+require_relative 'persistentvolumes'
+require_relative 'persistentvolumeclaims'
+require_relative 'jobs'
+require_relative 'cronjob'
+
+module Utilities
+  include Generic
+  include Namespaces
+  include Ingresses
+  include Nodes
+  include Endpoints
+  include Pods
+  include Services
+  include Deployments
+  include ReplicaSets
+  include ConfigMaps
+  include PersistentVolumes
+  include PersistentVolumeClaims
+  include Jobs
+  include CronJobs
+
+  # Trigger a cronjob
+  def trigger_cronjob(namespace, cronjob_name, restart_policy = 'Never')
+    cronjob_json = JSON.parse(get_single_namespaced_cronjob(namespace, cronjob_name))
+    cronjob_json['spec']['jobTemplate']['spec']['template']['spec']['restartPolicy'] = restart_policy
+    cronjob_json['metadata']['name'] += '-' + ('a'..'z').to_a.shuffle[0,8].join
+    json_config =
+        '{
+          "kind": "Job",
+          "apiVersion": "batch/v1",
+          "metadata": {
+            "name": ' + cronjob_json['metadata']['name'].to_json + '
+          },
+          "spec": {
+            "template": {
+              "spec": ' + cronjob_json['spec']['jobTemplate']['spec']['template']['spec'].to_json + '
+            }
+          }
+        }'
+    create_new_job(namespace, json_config)
+  end
+
+end

data/lib/ruby-kubernetes-controller/version.rb

@@ -1,4 +1,4 @@
 # Part of the RubyKubernetesController module
 module RubyKubernetesController
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-kubernetes-controller
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Shivansh Vij (ShivanshVij)
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-06 00:00:00.000000000 Z
+date: 2020-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -101,6 +101,7 @@ files:
 - lib/ruby-kubernetes-controller.rb
 - lib/ruby-kubernetes-controller/client.rb
 - lib/ruby-kubernetes-controller/configmaps.rb
+- lib/ruby-kubernetes-controller/cronjob.rb
 - lib/ruby-kubernetes-controller/deployments.rb
 - lib/ruby-kubernetes-controller/endpoints.rb
 - lib/ruby-kubernetes-controller/generic.rb
@@ -113,6 +114,7 @@ files:
 - lib/ruby-kubernetes-controller/pods.rb
 - lib/ruby-kubernetes-controller/replicasets.rb
 - lib/ruby-kubernetes-controller/services.rb
+- lib/ruby-kubernetes-controller/utilities.rb
 - lib/ruby-kubernetes-controller/version.rb
 - ruby-kubernetes-controller.gemspec
 homepage: https://github.com/IBM/ruby-kubernetes-controller/