Merge pull request #23 from OmegaVVeapon/silent-handlers

Use only on.event handlers

README.md

@@ -41,20 +41,6 @@ If you are looking to use this image with the [Grafana Helm chart](https://githu
 * Set `.Values.sidecar.image.repository` to `omegavveapon/kopf-k8s-sidecar` 
 * Set `.Values.sidecar.image.tag` to the latest tag in [Releases](https://github.com/OmegaVVeapon/kopf-k8s-sidecar/releases)
 
-### RBAC permissions
-
-Provide `patch` permissions for `configmaps` and `secrets` in the `values.yaml`
-
-```
-rbac:
--  extraClusterRoleRules: []
-+  extraClusterRoleRules:
-+    - apiGroups: [""]  # "" indicates the core API group
-+      resources: ["configmaps", "secrets"]
-+      verbs: ["patch"]
-```
-The operator needs to `patch` resources to add a `kopf.zalando.org/last-handled-configuration` annotation which is used to handle [change detection](https://kopf.readthedocs.io/en/stable/configuration/?highlight=last-handled-configuration#change-detection).
-
 ## Configuration Environment Variables
 
 | Variable | Required? | Default | Description |

app/conditions.py

@@ -24,6 +24,10 @@ def resource_is_desired(body, **_):
 
     return sidecar_settings.RESOURCE in (kind, 'both')
 
+def resource_is_cru(event, **_):
+    """Returns true if the resource was created, resumed or updated in the on.event handler"""
+    return not resource_is_deleted(event)
+
 def resource_is_deleted(event, **_):
     """Returns true if the resource was deleted in the on.event handler"""
     return event['type'] == 'DELETED'

app/io_helpers.py

@@ -67,19 +67,22 @@ def delete_file(body, kind, logger):
 
     for filename in body['data'].keys():
         filepath = get_filepath(filename, folder, kind, body)
-        logger.info("[DELETE:%s] Deleting file %s.", kind, filepath)
+        logger.info("[DELETED:%s] Deleting file %s.", kind, filepath)
         try:
             os.remove(filepath)
         except FileNotFoundError:
-            logger.error("[DELETE:%s] %s not found.", kind, filepath)
+            logger.error("[DELETED:%s] %s not found.", kind, filepath)
         except OSError as e:
             logger.error(e)
 
 def write_file(event, body, kind, logger):
     """
     Write contents to the desired filepath if they have changed.
     """
-    event = event.upper()
+    if event is None:
+        event = 'RESUMED'
+    else:
+        event = event.upper()
 
     folder = get_folder(body['metadata'])
     create_folder(folder, logger)

app/sidecar.py

@@ -4,7 +4,7 @@
 import contextlib
 import sidecar_settings
 from io_helpers import write_file, delete_file
-from conditions import label_is_satisfied, resource_is_desired, resource_is_deleted
+from conditions import *
 from list_mode import one_run
 import kopf
 
@@ -23,14 +23,11 @@ def startup_tasks(settings: kopf.OperatorSettings, logger, **_):
     # Disable k8s event logging
     settings.posting.enabled = False
 
-@kopf.on.resume('', 'v1', 'configmaps', when=kopf.all_([label_is_satisfied, resource_is_desired]))
-@kopf.on.create('', 'v1', 'configmaps', when=kopf.all_([label_is_satisfied, resource_is_desired]))
-@kopf.on.update('', 'v1', 'configmaps', when=kopf.all_([label_is_satisfied, resource_is_desired]))
-@kopf.on.resume('', 'v1', 'secrets', when=kopf.all_([label_is_satisfied, resource_is_desired]))
-@kopf.on.create('', 'v1', 'secrets', when=kopf.all_([label_is_satisfied, resource_is_desired]))
-@kopf.on.update('', 'v1', 'secrets', when=kopf.all_([label_is_satisfied, resource_is_desired]))
-def cru_fn(body, reason, logger, **_):
-    write_file(reason, body, body['kind'], logger)
+# Event types when not 'DELETED' can be 'ADDED', 'MODIFIED' and None. The latter being when the resource already existed when the operator started
+@kopf.on.event('', 'v1', 'configmaps', when=kopf.all_([label_is_satisfied, resource_is_desired, resource_is_created]))
+@kopf.on.event('', 'v1', 'secrets', when=kopf.all_([label_is_satisfied, resource_is_desired, resource_is_created]))
+def cru_fn(body, event, logger, **_):
+    write_file(event['type'], body, body['kind'], logger)
 
 @kopf.on.event('', 'v1', 'configmaps', when=kopf.all_([label_is_satisfied, resource_is_desired, resource_is_deleted]))
 @kopf.on.event('', 'v1', 'secrets', when=kopf.all_([label_is_satisfied, resource_is_desired, resource_is_deleted]))
@@ -45,13 +42,6 @@ def kopf_thread(
     asyncio.set_event_loop(loop)
     with contextlib.closing(loop):
 
-        # Since we're using an embedded operator we can't rely on CLI options to configure the logger
-        # we have to do it here, before we start the operator
-        #  kopf.configure(
-        #      debug=sidecar_settings.DEBUG,
-        #      verbose=sidecar_settings.VERBOSE
-        #  )
-
         # The Grafana Helm chart doesn't even use liveness probes for the sidecar... worth enabling?
         # liveness_endpoint = "http://0.0.0.0:8080/healthz"
 
@@ -77,7 +67,7 @@ def main():
         stop_flag = threading.Event()
         thread = threading.Thread(target=kopf_thread, kwargs=dict(
             stop_flag=stop_flag,
-            ready_flag=ready_flag,
+            ready_flag=ready_flag
         ))
         thread.start()
         ready_flag.wait()

examples/rbac.yaml

@@ -6,14 +6,7 @@ metadata:
 rules:
   - apiGroups: [""]
     resources: ["configmaps", "secrets"]
-    verbs: ["get", "watch", "list", "patch"]
-  # Framework: posting the events about the handlers progress/errors.
-  # - apiGroups: [events.k8s.io]
-  #   resources: [events]
-  #   verbs: [create]
-  # - apiGroups: [""]
-  #   resources: [events]
-  #   verbs: [create]
+    verbs: ["get", "watch", "list"]
 ---
 apiVersion: v1
 kind: ServiceAccount