kubernetes-operator 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3f00225b351939f42585587df92d9bd3e5425ded2a8c260f58171a39216bb77
-  data.tar.gz: 6eb6bf84877a2aabe98f6df1ebbe7a549822cf17cf1dfcc65d8813187d29202b
+  metadata.gz: 648d3409d77416f22cad190066b561a44dcff635d420f53fcc5fd96ab3d5d648
+  data.tar.gz: e7a978d1e2bf3ec613dcc0a23f338427143fff11d7baff8187ec40c9c52a82db
 SHA512:
-  metadata.gz: af548e2e4d2873aa1841cabf4c9c3021341f81a7e5fdb6f63b77fedd6a8dd5f917740dbf416346a31b722ee521084c0e1e8405cd9fee91c81f91a674004d27aa
-  data.tar.gz: 692bf36c849fc4b839376d1d9a03b80059e49441de9f4f9a81890950aab0d1d286d19a29b132df075ca4617c2a8566e557044b99c7a4fa0240b44799359ee524
+  metadata.gz: 50e28406518c4ed1c94f70b27ffc488fff793f790935ca569645da9b6c2b49ee6d53e24fbc2d09ff80dfbb3c805a07accbccc6af58825990acf5960a268b85df
+  data.tar.gz: 3c5fbb879e6bbd1989853fb44cab7fdb5b732f538ec801a1d5e11566114abca0a7a21b25cdb78264c7649bac4f5e05cc26208747541f3d43d37b23d61b63b179

data/README.md

@@ -1,10 +1,13 @@
 # Ruby Kubernetes Operator
-If you do not want to create your operators for kubernetes in golang, it is difficult to find good frameworks. This gem is used to implement a few basic functions and to quickly create your own operators based on ruby. It is not a framework, so the YAML CRDs still have to be created by hand.
+If you do not want to create your operators for kubernetes in golang, it is difficult to find good frameworks. This gem is used to implement a few basic functions andand helps eucht with a quick entry into the world of operators. Unlike the operator-sdk in golang, the gem does not offer yaml generators. You would have to create the crds.yml yourself.<br>
 
-## How it works?
-- Watch changes on CR.
-- Trigger Actions for Add,Update or Delete
-- Handle the finalizer on create and after delete
+## Current features
+
+- Basic: Watch changes of custom resources and trigger upsert (add, update) or delete methods.
+- Cache resource version in yaml store to avoid double events.
+- Handle the finalizer on create and after delete events.
+- Update status after successfuly passed upsert methods.
+- Provides an event handler, so you can easy create events forcustom resources. On deletion it also will clean up all lost events.
 
 ![KubernetesOperator.png](KubernetesOperator.png)
 
@@ -14,19 +17,92 @@ The gem is hosted on [rubygems.org](https://rubygems.org/gems/kubernetes-operato
 gem install kubernetes-operator
 ```
 ... or with bundler in your Gemfile.
+```
+source 'https://rubygems.org'
+gem 'kubernetes-operator'
+```
+
+## Usage
+An full example you will found in [./example](./example), also you can check our [yard](https://tobiaskuntzsch.gitlab.io/kubernetes-operator/) documentation.
 
-## Example
+### Watch events
+The simplest start is an operator who only listens to the upsert events and writes the status in a logfile.
 
 ```
 crdGroup = "exmaple.com"
 crdVersion = "v1alpha1"
 crdPlural = "myres"
 
-def my_custom_action(obj,k8sclient)
+def my_custom_action(obj)
     puts "Do some cool stuff for #{obj["metadata"]["crd_status"]} action of #{obj["metadata"]["name"]}"
 end
 
 opi = KubernetesOperator.new(crdGroup,crdVersion,crdPlural)
-opi.setAddMethod(method(:my_custom_action))
+opi.setUpsertMethod(method(:my_custom_action))
+opi.run()
+```
+
+You can also add an delete methode.
+
+```
+...
+
+def my_custom_action_fordelete(obj)
+    puts "Delete #{obj["metadata"]["crd_status"]} action of #{obj["metadata"]["name"]}"
+end
+
+...
+
+opi.setDeleteMethod(method(:my_custom_action_fordelete))
 opi.run()
+```
+### Return status subressources
+If you have activated the subresource status in your crd, you can return a status `[:status]` object.<br><br>
+Example resource definition:
+```
+spec:
+  ...
+  subresources:
+    status: {}
+  ...
+  validation:
+    openAPIV3Schema:
+      properties:
+        ...
+        status:
+          type: object
+          properties:
+            message:
+              type: "string"
+              minimum: 1
+```
+Example upsert method:
+```
+def upsert(obj)
+    {:status => {:message => "upsert works fine"}}
+end
+```
+Result:
+```
+Status:
+  Message:  upsert works fine
+```
+### Logging
+The operator framework generates an Log4r::Logger, you can also use this to send logs.
+```
+@logger = opi.getLogger()
+@logger.info("create new fancy sample with the name #{obj["spec"]["sampleName"]}")
+```
+### Events
+You can add events to your custom resource by using the EventHelper.
+```
+@eventHelper = opi.getEventHelper()
+@eventHelper.add(obj,"fancy sample event")
+```
+Result:
+```
+Events:
+  Type    Reason  Age   From                Message
+  ----    ------  ----  ----                -------
+  Normal  Upsert  36s   KubernetesOperator  fancy sample event
 ```

data/lib/kubernetes-operator.rb

@@ -242,7 +242,7 @@ class KubernetesOperator
                             unless isCached
                                 # trigger action
                                 @logger.info("trigger add action for #{notice[:object][:metadata][:name]} (#{notice[:object][:metadata][:uid]})")
-                                resp = @addMethod.call(notice[:object],@k8sclient)
+                                resp = @addMethod.call(notice[:object])
                                 # update status
                                 if resp[:status]
                                     @k8sclient.patch_entity(@crdPlural,notice[:object][:metadata][:name]+"/status", {status: resp[:status]},'merge-patch',@options[:namespace])
@@ -266,7 +266,7 @@ class KubernetesOperator
                                 unless notice[:object][:metadata][:deletionTimestamp]
                                     # trigger action
                                     @logger.info("trigger update action for #{notice[:object][:metadata][:name]} (#{notice[:object][:metadata][:uid]})")
-                                    resp = @updateMethod.call(notice[:object],@k8sclient)
+                                    resp = @updateMethod.call(notice[:object])
                                     # update status
                                     if resp[:status]
                                         @k8sclient.patch_entity(@crdPlural,notice[:object][:metadata][:name]+"/status", {status: resp[:status]},'merge-patch',@options[:namespace])
@@ -279,7 +279,7 @@ class KubernetesOperator
                                 else
                                     # trigger action
                                     @logger.info("trigger delete action for #{notice[:object][:metadata][:name]} (#{notice[:object][:metadata][:uid]})")
-                                    @updateMethod.call(notice[:object],@k8sclient)
+                                    @deleteMethod.call(notice[:object])
                                     # remove finalizer
                                     @logger.info("remove finalizer to #{notice[:object][:metadata][:name]} (#{notice[:object][:metadata][:uid]})")
                                     patched = @k8sclient.patch_entity(@crdPlural,notice[:object][:metadata][:name], {metadata: {finalizers: nil}},'merge-patch',@options[:namespace])
@@ -313,7 +313,7 @@ class KubernetesOperator
 
     # default methode, only an esay print command
     private
-        def defaultActionMethod(obj,k8sclient)
+        def defaultActionMethod(obj)
             puts "{leve: \"info\", action: \"#{obj["metadata"]["crd_status"]}\", ressource: \"#{obj["metadata"]["namespace"]}/#{obj["metadata"]["name"]}\"}"
         end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kubernetes-operator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Tobias Kuntzsch