kubeler 0.1.2__py3-none-any.whl → 0.1.4__py3-none-any.whl

kubeler/main.py

@@ -1,5 +1,6 @@
 import argparse
 from .scripts.installer import Installer
+from dotenv import load_dotenv
 
 def main():
     parser = argparse.ArgumentParser(description="Installer script")
@@ -9,11 +10,17 @@ def main():
     install_parser = subparsers.add_parser('install', help='Install command')
     install_parser.add_argument('--installer', type=str, default='./installer.yaml', help='Path to the config YAML file')
     install_parser.add_argument('--kube-config', type=str, default='~/kube/config', help='Path to the kube config file')
-
+    install_parser.add_argument('--start-from', type=str, default=None, help='Start from a specific step')
+    install_parser.add_argument('--steps', type=str, default=None, help='Only run specific steps, comma separated')
+    install_parser.add_argument('--excludes', type=str, default=None, help='Exlude some steps, comma separated')
+    install_parser.add_argument('--watch', type=str, default=None, help='Watch for changes')
     args = parser.parse_args()
 
+    # load .env content to environment variables
+    load_dotenv()
+
     if args.command == 'install':
-        installer = Installer(installer=args.installer, kube_config=args.kube_config)
+        installer = Installer(installer=args.installer, kube_config=args.kube_config, start_from=args.start_from, steps=args.steps, excludes=args.excludes, watch=args.watch)
         installer.install()
 
 if __name__ == "__main__":

kubeler/scripts/installer.py

@@ -1,12 +1,21 @@
 import yaml, os, sys, subprocess, shutil, jinja2
+from kubernetes import client, config as k8sconfig
 from .models.kubeler import Kubeler
+from .watchdog import watch_directory
 
 tmp_dir = "/tmp/kubeler"
+k8sconfig.load_kube_config()
+v1 = client.CoreV1Api()
 
 class Installer:
-    def __init__(self, installer, kube_config):
+    def __init__(self, installer, kube_config, start_from, steps, excludes, watch):
         self.installer = installer
         self.kube_config = kube_config
+        self.start_from = start_from
+        self.kube_config = kube_config
+        self.steps = steps
+        self.excludes = excludes
+        self.watch = watch
 
         # get the directory path of the installer and kube_config
         self.installer_dir_path = os.path.dirname(installer)
@@ -68,19 +77,25 @@ class Installer:
                 
                 # get commands defined in the file
                 commands = self.load_file(file_path)
-                for command in commands:
-                    print("Executing command: ", command)
-                    cmd = command.split()
-                    process = subprocess.Popen(cmd, cwd=execution_dir, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, bufsize=1, universal_newlines=True)
-                    for line in process.stdout:
-                        print(line, end="")
-                        sys.stdout.flush()
-                    process.wait()
+                self.execute(commands, execution_dir)
 
                 # if config_path exists, restore the file
                 if os.path.exists(config_path):
                     os.remove(config_path)
-                
+
+        if kubeler.group.watch.enabled == True and self.watch == "true":
+            watch_directory(self, os.path.abspath(self.installer_dir_path), kubeler.group.watch.dir)
+
+    def execute(self, commands, execution_dir):
+        for command in commands:
+            print("Executing command: ", command)
+            cmd = command.split()
+            process = subprocess.Popen(cmd, cwd=execution_dir, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, bufsize=1, universal_newlines=True)
+            for line in process.stdout:
+                print(line, end="")
+                sys.stdout.flush()
+            process.wait()
+
     # if there some files in the directory, load them
     def load_files_in_dir(self, dir):
         files = []
@@ -96,7 +111,9 @@ class Installer:
             for line in file:
                 if line.startswith("#cmd:"):
                     command = line.split(":", 1)[1].strip()
+                    command = self.handle_helm_chart_idempotency(command)
                     commands.append(command)
+                        
         return commands
 
     #  load the configuration file and parse to Kubeler model
@@ -127,7 +144,33 @@ class Installer:
                     if var.value.startswith("env."):
                         env_var = var.value.split("env.")[1]
                         var.value = os.environ.get(env_var)
-                        
+
+        # handle excludes
+        if self.excludes != None:
+            excludes = self.excludes.split(",")
+            for exclude in excludes:
+                for step in kubeler.group.steps:
+                    if step.name == exclude:
+                        kubeler.group.steps.remove(step)
+        
+        for step in kubeler.group.steps:
+            if step.exclude == "yes" or step.exclude == True:
+                kubeler.group.steps.remove(step)
+
+        # handle start from step
+        if self.start_from != None:
+            start_from = self.start_from
+            for step in kubeler.group.steps:
+                if step.name == start_from:
+                    kubeler.group.steps = kubeler.group.steps[kubeler.group.steps.index(step):]
+
+        # handle only run specific steps
+        if self.steps != None:
+            steps = self.steps.split(",")
+            for step in kubeler.group.steps[:]:
+                if step.name not in steps:
+                    kubeler.group.steps.remove(step)
+
         return kubeler
 
     # open the configuration file    
@@ -137,4 +180,42 @@ class Installer:
                 data = yaml.safe_load(stream)
                 return data
             except yaml.YAMLError as exc:
-                raise ValueError("Failed to load configuration")
+                raise ValueError("Failed to load configuration")
+            
+    def is_helm_chart_installed(self, release_name, namespace="default"):
+        secrets = v1.list_namespaced_secret(namespace).items
+        for secret in secrets:
+            labels = secret.metadata.labels or {}
+            if labels.get("owner") == "helm" and labels.get("name") == release_name:
+                return True
+        return False
+    
+    def handle_helm_chart_idempotency(self, command):
+        # check if it's helm from: #cmd: helm install ...
+        if command.startswith("helm install"):
+            # get namespace from some scenarios:
+            # -n <namespace>
+            # --namespace <namespace>
+            # --namespace=<namespace>
+            namespace = None
+            if "-n" in command:
+                namespace = command.split("-n")[1].split()[0]
+            elif "--namespace" in command:
+                namespace = command.split("--namespace")[1].split()[0]
+            elif "--namespace=" in command:
+                namespace = command.split("--namespace=")[1].split()[0]
+            
+            # get release name from: #cmd: helm install <release_name> ...
+            # get after `helm install` or `helm upgrade`
+            release_name = None
+            if "install" in command:
+                release_name = command.split("install")[1].split()[0]
+            elif "upgrade" in command:
+                release_name = command.split("upgrade")[1].split()[0]
+            
+            if namespace != None:
+                if self.is_helm_chart_installed(release_name, namespace):
+                    # remove --install and replace install with upgrade
+                    command = command.replace("--install", "").replace("install", "upgrade")
+            
+        return command

kubeler/scripts/models/kubeler.py

@@ -14,10 +14,16 @@ class Step(BaseModel):
     dir: str = Field(title="Directory of the step", min_length=3, max_length=255)
     files: List[str] | None = Field(default=None, title="Files to be processed in order")
     vars: List[Variable] | None = Field(default=None,title="Variables to be passed to the step")
+    exclude: str | bool | None = Field(default=None, title="Exclude the step from execution")
+
+class Watch(BaseModel):
+    enabled: bool = Field(title="Watch enabled")
+    dir: List[str] = Field(default=None, title="Directory to be watched")
 
 class Group(BaseModel):
     name: str = Field(title="Initial Command")
     steps: List[Step] = Field(title="List of steps to be executed")
+    watch: Watch | None = Field(default=None,title="Watch configuration")
 
 class Kubeler(BaseModel):
     init: Init | None = Field(default=None,title="Initial Command")

kubeler/scripts/models/kubernetes.py

@@ -0,0 +1,7 @@
+from pydantic import BaseModel
+from pydantic.fields import Field
+
+class Resource(BaseModel):
+    type: str = Field(title="Type of the resource", min_length=3)
+    name: str | bool | int = Field(title="Name of the resource", min_length=3)
+    namespace: str | bool | int = Field(title="Namespace of the resource", min_length=3)

kubeler/scripts/watchdog.py

@@ -0,0 +1,36 @@
+import time, os
+from watchdog.observers import Observer
+from watchdog.events import FileSystemEventHandler
+
+class WatchHandler(FileSystemEventHandler):
+    def __init__(self, handler):
+        self.handler = handler
+
+    def on_modified(self, event):
+        if not event.is_directory:
+            print(f"File modified: {event.src_path}")
+            commands = self.handler.load_file(event.src_path)
+            self.handler.execute(commands, os.path.dirname(event.src_path))
+
+    def on_created(self, event):
+        if not event.is_directory:
+            print(f"File created: {event.src_path}")
+
+    def on_deleted(self, event):
+        if not event.is_directory:
+            print(f"File deleted: {event.src_path}")
+
+def watch_directory(handler, dir, paths=["."]):
+    event_handler = WatchHandler(handler)
+    observer = Observer()
+    for path in paths:
+        dir_path = os.path.join(dir, path)
+        observer.schedule(event_handler, dir_path, recursive=True)
+    observer.start()
+
+    try:
+        while True:
+            time.sleep(1)
+    except KeyboardInterrupt:
+        observer.stop()
+    observer.join()

{kubeler-0.1.2.dist-info → kubeler-0.1.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: kubeler
-Version: 0.1.2
+Version: 0.1.4
 Summary: A dead simple Kubernetes Resources installer
 Home-page: https://github.com/glendmaatita/kubeler
 Author: Glend Maatita
@@ -14,6 +14,8 @@ License-File: LICENSE
 Requires-Dist: jinja2>=3.1.5
 Requires-Dist: kubernetes>=32.0.0
 Requires-Dist: pydantic>=2.10.6
+Requires-Dist: python-dotenv>=1.0.1
+Requires-Dist: watchdog>=6.0.0
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -138,7 +140,7 @@ You can also reference variables from a previous step using `ref.`.
           value: ref.redis.vars.password
 ```
 
-You can also reference variables from environment variables using `env.`.
+You can also reference variables from environment variables using `env.`. In addition, using `.env` file defined in the same directory with `installer.yaml` also works for this case.
 
 ```
 - name: harbor
@@ -154,3 +156,63 @@ You can also reference variables from environment variables using `env.`.
 - `dir`: Directory where the manifest files reside.
 - `files`: List of files in the directory that will be executed in order.
 - `vars`: Variables for dynamic values inside the manifest file.
+
+## Options
+
+There are some options available with installing Kubernetes Resources using Kubeler.
+
+### Exclude Steps
+
+Use attributes `exclude=yes` or argument `--excludes` if you want to skip some steps from execution
+
+```
+steps:
+  - name: cluster
+    dir: ./cluster
+    exclude: yes
+```
+
+or 
+```
+--installer=./../examples/installer.yaml --excludes=argocd,redis
+```
+
+### Define starting point
+
+Use argument `--start-from` if you want to execute steps from a certain point
+
+```
+--installer=./../examples/installer.yaml --start-from=argocd
+```
+
+## Execute only some steps
+
+Use argument `--steps` if you want to only execute some steps and exclude the other
+
+```
+--installer=./../examples/installer.yaml --steps=argocd,redis
+```
+
+## Watching for file changes
+
+Use the `--watch` argument to monitor a directory and automatically apply changes when they occur.
+
+Update `installer.yaml` to set `watch` attribute
+
+```
+group:
+  name: k8s
+  watch:
+    enabled: true
+    dir: 
+      - ./applications
+      - ./cluster
+```
+
+and then, run
+
+```
+kubeler install --installer=./examples/installer.yaml --watch=true
+```
+
+

kubeler-0.1.4.dist-info/RECORD

@@ -0,0 +1,14 @@
+kubeler/__init__.py,sha256=xuYziAiR_MvvngneqgskzBPoVTHLwxRs6l--kORxv7s,7
+kubeler/main.py,sha256=6Bn1OguVUMjx24plZ3J9PCeVbQrcMAxLP7ukIg9CrOI,1437
+kubeler/scripts/__init__.py,sha256=xuYziAiR_MvvngneqgskzBPoVTHLwxRs6l--kORxv7s,7
+kubeler/scripts/installer.py,sha256=ercx3I4ZCs02-QMxoSGm21TIyNJwRvwZeQWTk1hnM9Y,8937
+kubeler/scripts/watchdog.py,sha256=t-iSqNtYm0_i4BOnnDScGdYvder9QUjEid346zoiW9E,1123
+kubeler/scripts/models/__init__.py,sha256=xuYziAiR_MvvngneqgskzBPoVTHLwxRs6l--kORxv7s,7
+kubeler/scripts/models/kubeler.py,sha256=xdpHTxt1wNwjBNHrRu9alj7M8Jp6UDXwPxe_adPH5kc,1357
+kubeler/scripts/models/kubernetes.py,sha256=-G6ppVwXu2Z2zfXXf2Zl9T6fXofSbF25MuYaKdsclV0,327
+kubeler-0.1.4.dist-info/LICENSE,sha256=g8iEDGIIhDh0wHq4B7md4cWUJ69HC13i010cmASC9Lg,1059
+kubeler-0.1.4.dist-info/METADATA,sha256=UagyoubabOH9YjXEj6WLaMGVcZJ_6CS8PFt6-zzBUUY,4661
+kubeler-0.1.4.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+kubeler-0.1.4.dist-info/entry_points.txt,sha256=-HM8L2j9zOFjn8DGCEqANNS-rSvA8dXlyzWhTZD_02Q,46
+kubeler-0.1.4.dist-info/top_level.txt,sha256=Chw1LcDOq_cKEex9nHyQOMq8-C6QpLdJjK1s_1MnDEk,8
+kubeler-0.1.4.dist-info/RECORD,,

kubeler-0.1.2.dist-info/RECORD

@@ -1,12 +0,0 @@
-kubeler/__init__.py,sha256=xuYziAiR_MvvngneqgskzBPoVTHLwxRs6l--kORxv7s,7
-kubeler/main.py,sha256=awZQX-gALoffxvgGHWqGKlcJ68jOv5goTWQvAebL9Ls,822
-kubeler/scripts/__init__.py,sha256=xuYziAiR_MvvngneqgskzBPoVTHLwxRs6l--kORxv7s,7
-kubeler/scripts/installer.py,sha256=21xTHLDQ24rshuJtw6NXbnnSVhPeNVcZDXUAVNQeV9I,5561
-kubeler/scripts/models/__init__.py,sha256=xuYziAiR_MvvngneqgskzBPoVTHLwxRs6l--kORxv7s,7
-kubeler/scripts/models/kubeler.py,sha256=0NMrxdrscikNLx3nS1097AInb39NQkbaVpBE17Dj8e4,1041
-kubeler-0.1.2.dist-info/LICENSE,sha256=g8iEDGIIhDh0wHq4B7md4cWUJ69HC13i010cmASC9Lg,1059
-kubeler-0.1.2.dist-info/METADATA,sha256=31vh65R7FZHI6CpHCDpZsTLJlC7DN_vIB3dYpDP_Y3I,3380
-kubeler-0.1.2.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-kubeler-0.1.2.dist-info/entry_points.txt,sha256=-HM8L2j9zOFjn8DGCEqANNS-rSvA8dXlyzWhTZD_02Q,46
-kubeler-0.1.2.dist-info/top_level.txt,sha256=Chw1LcDOq_cKEex9nHyQOMq8-C6QpLdJjK1s_1MnDEk,8
-kubeler-0.1.2.dist-info/RECORD,,