kubernetes-operator 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f594436b606a9874d099009d5428952569792547c090199b08553b5bac9828bf
-  data.tar.gz: cf8f0c651177e18aa07b682cb05c4b0c716908151e72dcadbae2edb9c4ee4139
+  metadata.gz: c3f00225b351939f42585587df92d9bd3e5425ded2a8c260f58171a39216bb77
+  data.tar.gz: 6eb6bf84877a2aabe98f6df1ebbe7a549822cf17cf1dfcc65d8813187d29202b
 SHA512:
-  metadata.gz: 04221fa717adb6c04562554236980e56a01f8ea90c491f33cabe6df62b99935739cc63ecbc03cd1c7db509cadb857bf5ed96dc8ddc4654d407d15e1f8a774385
-  data.tar.gz: a6564a4cbf18e78ee6a7dee2589c1db1862763b61133c3ba7f14f63f636a18847425acf09767f33459313b29ea731a98d32c5d49ce9b9b9ed07223f049e05717
+  metadata.gz: af548e2e4d2873aa1841cabf4c9c3021341f81a7e5fdb6f63b77fedd6a8dd5f917740dbf416346a31b722ee521084c0e1e8405cd9fee91c81f91a674004d27aa
+  data.tar.gz: 692bf36c849fc4b839376d1d9a03b80059e49441de9f4f9a81890950aab0d1d286d19a29b132df075ca4617c2a8566e557044b99c7a4fa0240b44799359ee524

data/lib/kubernetes-operator.rb

@@ -13,8 +13,111 @@ require 'log_formatter'
 require 'log_formatter/log4r_json_formatter'
 require 'json'
 
+class EventHelper
+
+    # EventHelper initialize provides an helper class to add and delete events from ressources
+    # @see https://www.bluematador.com/blog/kubernetes-events-explained Documentation
+    # @param logger [Log4r::Logger] Logger for this class
+    def initialize(logger)
+        # logging
+        @logger = logger
+
+        # kubeconfig
+        # we need our own client because its an different api path
+        # (for local development it's nice to use .kube/config)
+        if File.exist?("#{Dir.home}/.kube/config")
+            config = Kubeclient::Config.read(ENV['KUBECONFIG'] || "#{ENV['HOME']}/.kube/config")
+            context = config.context
+            @k8sclient = Kubeclient::Client.new(
+                context.api_endpoint,
+                'v1',
+                ssl_options: context.ssl_options,
+                auth_options: context.auth_options
+            )
+        else
+            auth_options = {
+                bearer_token_file: '/var/run/secrets/kubernetes.io/serviceaccount/token'
+            }
+            ssl_options = {}
+            if File.exist?("/var/run/secrets/kubernetes.io/serviceaccount/ca.crt")
+                ssl_options[:ca_file] = "/var/run/secrets/kubernetes.io/serviceaccount/ca.crt"
+            end
+            @k8sclient = Kubeclient::Client.new(
+                'https://kubernetes.default.svc',
+                'v1',
+                auth_options: auth_options,
+                ssl_options:  ssl_options
+            )
+        end
+    end
+
+    # Add an event
+    # @param obj [Hash] Kubernetes custom resource object as hash (required)
+    # @param message [string] Event message (required)
+    # @param reason [string] Event reason (default: "Upsert")
+    # @param type [string] Event type (default: "Normal")
+    # @param component [string] Event component (default: "KubernetesOperator")
+    def add(obj,message,reason = "Upsert",type = "Normal", component = "KubernetesOperator")
+        begin
+            event = Kubeclient::Resource.new
+            time = Time.new.utc
+
+            _tmpNS = obj[:metadata][:namespace]
+
+            event.firstTimestamp = time.strftime("%Y-%m-%dT%H:%M:%SZ")
+            event.lastTimestamp = time.strftime("%Y-%m-%dT%H:%M:%SZ")
+            event.involvedObject = {}
+            event.involvedObject.apiVersion = obj[:apiVersion]
+            event.involvedObject.kind = obj[:kind]
+            event.involvedObject.name = obj[:metadata][:name]
+            event.involvedObject.namespace = obj[:metadata][:namespace]
+            event.involvedObject.resourceVersion = obj[:metadata][:resourceVersion]
+            event.involvedObject.uid = obj[:metadata][:uid]
+            event.kind = "Event"
+            event.message = message
+            event.metadata = {}
+            event.metadata.name = "#{obj[:metadata][:name]}.#{time.to_i}"
+            event.metadata.namespace = obj[:metadata][:namespace] ||= "default"
+            event.reason = reason
+            event.source = {}
+            event.source.component = component
+            event.type = type
+
+            @k8sclient.create_event(event)
+
+            @logger.info("add event #{message}(#{type}) to #{obj[:metadata][:name]}(#{obj[:metadata][:uid]})")
+        rescue => exception
+            @logger.error(exception.inspect)
+        end
+
+    end
+
+    # Delete all events from an cr
+    # @param obj [Hash] Kubernetes custom resource object as hash (required)
+    def deleteAll(obj)
+        begin
+            events = @k8sclient.get_events(namespace: obj[:metadata][:namespace],field_selector: "involvedObject.uid=#{obj[:metadata][:uid]}")
+            events.each do |event|
+                @logger.info("delete event #{event[:metadata][:name]}(#{event[:metadata][:namespace]}) from #{obj[:metadata][:name]}(#{obj[:metadata][:uid]})")
+                @k8sclient.delete_event(event[:metadata][:name],event[:metadata][:namespace])
+            end
+        rescue => exception
+            @logger.error(exception.inspect)
+        end
+    end
+end
+
 class KubernetesOperator
 
+    # Operator Class to run the core operator functions for your crd
+    # @see https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definition-versioning/ Documentation
+    # @param group [string] Group from crd
+    # @param version [string] Api Version from crd
+    # @param plural [string] Name (plural) from crd
+    # @param options [Hash] Additional options
+    # @option options [Hash] sleepTimer Time to wait for retry if the watch event stops
+    # @option options [Hash] namespace Watch only an namespace, default watch all namespaces
+    # @option options [Hash] persistence_location Location for the yaml store, default is /tmp/persistence
     def initialize(crdGroup, crdVersion, crdPlural, options = {} )
         # parameter
         @crdGroup = crdGroup
@@ -67,34 +170,55 @@ class KubernetesOperator
                 ssl_options:  ssl_options
             )
         end
+
+        # event helper
+        @eventHelper = EventHelper.new(@logger)
     end
 
     # Action Methods
+
+    # Set the method that was triggert then an add cr event occurred
+    # @param callback [methode] Ruby methode
     def setAddMethod(callback)
         @addMethod = callback
     end
 
+    # Set the method that was triggert then an update cr event occurred
+    # @param callback [methode] Ruby methode
     def setUpdateMethod(callback)
         @updateMethod = callback
     end
 
+    # Set the method that was triggert then an add or update cr event occurred
+    # This function overwrite setAddMethod and setUpdateMethod
+    # @param callback [methode] Ruby methode
     def setUpsertMethod(callback)
         @updateMethod = callback
         @addMethod = callback
     end
 
+    # Set the method that was triggert then an delete cr event occurred
+    # @param callback [methode] Ruby methode
     def setDeleteMethod(callback)
         @deleteMethod = callback
     end
 
-    # Logger Methods
+    # Helper Methods
+
+    # get the logger from the operatore framework
+    # @return [Log4r::Logger] logger
     def getLogger()
         return @logger
     end
 
-    # Controller
-    def run
+    # get the event helper from the operatore framework
+    # @return [EventHelper] event helper
+    def getEventHelper()
+        return @eventHelper
+    end
 
+    # start the operator to watch your cr
+    def run
         @logger.info("start the operator")
         # load methods
         @addMethod = method(:defaultActionMethod) unless @addMethod
@@ -102,7 +226,6 @@ class KubernetesOperator
         @deleteMethod = method(:defaultActionMethod) unless @deleteMethod
 
         while true
-
             begin
                 if @options[:namespace]
                     watcher = @k8sclient.watch_entities(@crdPlural,@options[:namespace])
@@ -117,9 +240,6 @@ class KubernetesOperator
                         when "ADDED"
                             # check if version is already processed
                             unless isCached
-                                # add finalizer
-                                @logger.info("add finalizer to #{notice[:object][:metadata][:name]} (#{notice[:object][:metadata][:uid]})")
-                                patched = @k8sclient.patch_entity(@crdPlural,notice[:object][:metadata][:name], {metadata: {finalizers: ["#{@crdPlural}.#{@crdVersion}.#{@crdGroup}"]}},'merge-patch',@options[:namespace])
                                 # trigger action
                                 @logger.info("trigger add action for #{notice[:object][:metadata][:name]} (#{notice[:object][:metadata][:uid]})")
                                 resp = @addMethod.call(notice[:object],@k8sclient)
@@ -127,6 +247,9 @@ class KubernetesOperator
                                 if resp[:status]
                                     @k8sclient.patch_entity(@crdPlural,notice[:object][:metadata][:name]+"/status", {status: resp[:status]},'merge-patch',@options[:namespace])
                                 end
+                                # add finalizer
+                                @logger.info("add finalizer to #{notice[:object][:metadata][:name]} (#{notice[:object][:metadata][:uid]})")
+                                patched = @k8sclient.patch_entity(@crdPlural,notice[:object][:metadata][:name], {metadata: {finalizers: ["#{@crdPlural}.#{@crdVersion}.#{@crdGroup}"]}},'merge-patch',@options[:namespace])
                                 # save version
                                 @store.transaction do
                                     @store[patched[:metadata][:uid]] = patched[:metadata][:resourceVersion]
@@ -138,7 +261,7 @@ class KubernetesOperator
                         # cr was change or deleted (if finalizer is set, it an modified call, not an delete)
                         when "MODIFIED"
                             # check if version is already processed
-                            if isCached != notice[:object][:metadata][:resourceVersion]
+                            if isCached.to_i < notice[:object][:metadata][:resourceVersion].to_i
                                 # check if it's an delete event
                                 unless notice[:object][:metadata][:deletionTimestamp]
                                     # trigger action
@@ -165,94 +288,32 @@ class KubernetesOperator
                                 @logger.info("skip update action for #{notice[:object][:metadata][:name]} (#{notice[:object][:metadata][:uid]}), found version in cache")
                             end
                         when "DELETED"
-                            @logger.info("#{notice[:object][:metadata][:name]} (#{notice[:object][:metadata][:uid]}) is done")
+                            # clear events, if delete was successfuly
+                            @logger.info("#{notice[:object][:metadata][:name]} (#{notice[:object][:metadata][:uid]}) is done, clean up events")
+                            @eventHelper.deleteAll(notice[:object])
                         else
+                            # upsi, something wrong
                             @logger.info("strange things are going on here, I found the type "+notice[:type])
                         end
                     rescue => exception
                         @logger.error(exception.inspect)
                     end
                 end
+                # watcher is done, lost connection ...
                 watcher.finish
-
-                ## Search for ressources
-                #_ressources = @k8sclient.get(@crdGroup+"/"+@crdVersion).resource(@crdPlural).list()
-
-                #_ressources.each do |_i|
-                #    _uid = _i["metadata"]["uid"]
-                #    _v = _i["metadata"]["resourceVersion"]
-
-                #    if @options[:namespace] == nil || @options[:namespace].contains(_i["metadata"]["namespace"])
-                #        _from_cache = @store.transaction{@store[_uid]}
-
-                #        unless _from_cache
-                #            # Add finalizer and refresh version number
-                #            _i[:metadata][:finalizers] = ["#{@crdPlural}.#{@crdVersion}.#{@crdGroup}"]
-                #            _i = @k8sclient.api(@crdGroup+"/"+@crdVersion).resource(@crdPlural).update_resource(_i)
-
-                #            # call the action method
-                #            _i["metadata"]["crd_status"] = "add"
-                #            @logger.info("add custom resource #{_i["metadata"]["name"]}@#{_i["metadata"]["namespace"]}") if _i["metadata"]["namespace"]
-                #            @logger.info("add custom resource #{_i["metadata"]["name"]}@cluster") unless _i["metadata"]["namespace"]
-                #            @addMethod.call(_i,@k8sclient)
-
-                #            # update status
-                #            _i[:status] = {message: "Test"}
-                #            _i = @k8sclient.api(@crdGroup+"/"+@crdVersion).resource(@crdPlural).update_resource(_i)
-
-                #            # Cache last version of ressources
-                #            @store.transaction do
-                #                @store[_uid] = _i["metadata"]["resourceVersion"]
-                #                @store.commit
-                #            end
-
-                #        else
-                #            # only trigger action on change or delete event
-                #            unless _from_cache == _v
-                #                if _i["metadata"]["deletionTimestamp"]
-                #                    # remove finalizers
-                #                    _i[:metadata][:finalizers] = []
-                #                    @k8sclient.api(@crdGroup+"/"+@crdVersion).resource(@crdPlural).update_resource(_i)
-
-                #                    # call the action method
-                #                    _i["metadata"]["crd_status"] = "delete"
-                #                    @logger.info("delete custom resource #{_i["metadata"]["name"]}@#{_i["metadata"]["namespace"]}") if _i["metadata"]["namespace"]
-                #                    @logger.info("delete custom resource #{_i["metadata"]["name"]}@cluster") unless _i["metadata"]["namespace"]
-                #                    @deleteMethod.call(_i,@k8sclient)
-                #                else
-                #                    # store new version in cache
-                #                    @store.transaction do
-                #                        @store[_uid] = _v
-                #                        @store.commit
-                #                    end
-
-                #                    # call the action method
-                #                    _i["metadata"]["crd_status"] = "update"
-                #                    @logger.info("update custom resource #{_i["metadata"]["name"]}@#{_i["metadata"]["namespace"]}") if _i["metadata"]["namespace"]
-                #                    @logger.info("update custom resource #{_i["metadata"]["name"]}@cluster") unless _i["metadata"]["namespace"]
-                #                    @updateMethod.call(_i,@k8sclient)
-                #                end
-                #            end
-                #        end
-                #    end
-                #end
-
             rescue => exception
                 @logger.error(exception.inspect)
             end
 
-            # Done
+            # done
             sleep @options[:sleepTimer]
 
         end
     end
 
+    # default methode, only an esay print command
     private
         def defaultActionMethod(obj,k8sclient)
             puts "{leve: \"info\", action: \"#{obj["metadata"]["crd_status"]}\", ressource: \"#{obj["metadata"]["namespace"]}/#{obj["metadata"]["name"]}\"}"
         end
 end
-
-
-
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubernetes-operator
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Tobias Kuntzsch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-29 00:00:00.000000000 Z
+date: 2020-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kubeclient