circuit breaker plugin skeleton setup

Author: Camillarhi

resources/plugins/circuitbreaker/charts/circuitbreaker/.helmignore

@@ -0,0 +1,23 @@
+# Patterns to ignore when building packages.
+# This supports shell glob matching, relative path matching, and
+# negation (prefixed with !). Only one pattern per line.
+.DS_Store
+# Common VCS dirs
+.git/
+.gitignore
+.bzr/
+.bzrignore
+.hg/
+.hgignore
+.svn/
+# Common backup files
+*.swp
+*.bak
+*.tmp
+*.orig
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/

resources/plugins/circuitbreaker/charts/circuitbreaker/Chart.yaml

@@ -0,0 +1,5 @@
+apiVersion: v2
+name: circuitbreaker
+description: A Helm chart to deploy Circuit Breaker
+version: 0.1.0
+appVersion: "0.1.0"

resources/plugins/circuitbreaker/charts/circuitbreaker/templates/_helpers.tpl

@@ -0,0 +1,7 @@
+{{- define "mychart.name" -}}
+{{- .Chart.Name | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+
+{{- define "mychart.fullname" -}}
+{{- printf "%s-%s" (include "mychart.name" .) .Release.Name | trunc 63 | trimSuffix "-" -}}
+{{- end -}}

resources/plugins/circuitbreaker/charts/circuitbreaker/templates/pod.yaml

@@ -0,0 +1,17 @@
+apiVersion: v1
+kind: Pod
+metadata:
+  name: {{ include "mychart.fullname" . }}
+  labels:
+    app: {{ include "mychart.name" . }}
+    mission: {{ .Values.name }}
+spec:
+  containers:
+    - name: {{ .Values.name }}
+      image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
+      imagePullPolicy: {{ .Values.image.pullPolicy }}
+      command: ["sh", "-c"]
+      args:
+      - echo "Hello {{ .Values.mode }}";
+      resources: {}
+     

resources/plugins/circuitbreaker/charts/circuitbreaker/values.yaml

@@ -0,0 +1,5 @@
+name: "circuitbreaker"
+image:
+  repository: "camillarhi/circuitbreaker"
+  tag: "0.2.3"
+  pullPolicy: IfNotPresent

resources/plugins/circuitbreaker/plugin.py

@@ -0,0 +1,117 @@
+#!/usr/bin/env python3
+import json
+import logging
+from enum import Enum
+from pathlib import Path
+import time
+from typing import Optional
+
+import click
+
+from warnet.constants import PLUGIN_ANNEX, AnnexMember, HookValue, WarnetContent
+from warnet.process import run_command
+
+MISSION = "circuitbreaker"
+PRIMARY_CONTAINER = MISSION
+
+PLUGIN_DIR_TAG = "plugin_dir"
+
+
+class PluginError(Exception):
+    pass
+
+
+log = logging.getLogger(MISSION)
+if not log.hasHandlers():
+    console_handler = logging.StreamHandler()
+    console_handler.setLevel(logging.DEBUG)
+    formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
+    console_handler.setFormatter(formatter)
+    log.addHandler(console_handler)
+log.setLevel(logging.DEBUG)
+log.propagate = True
+
+class PluginContent(Enum):
+    MODE = "mode"
+    MAX_PENDING_HTLCS = "maxPendingHtlcs"
+    RATE_LIMIT = "rateLimit"
+
+@click.group()
+@click.pass_context
+def circuitbreaker(ctx):
+    """Commands for the Circuit Breaker plugin"""
+    ctx.ensure_object(dict)
+    plugin_dir = Path(__file__).resolve().parent
+    ctx.obj[PLUGIN_DIR_TAG] = Path(plugin_dir)
+
+
+@circuitbreaker.command()
+@click.argument("plugin_content", type=str)
+@click.argument("warnet_content", type=str)
+@click.pass_context
+def entrypoint(ctx, plugin_content: str, warnet_content: str):
+    """Plugin entrypoint"""
+    plugin_content: dict = json.loads(plugin_content)
+    warnet_content: dict = json.loads(warnet_content)
+
+    hook_value = warnet_content.get(WarnetContent.HOOK_VALUE.value)
+
+    assert hook_value in {
+        item.value for item in HookValue
+    }, f"{hook_value} is not a valid HookValue"
+
+    if warnet_content.get(PLUGIN_ANNEX):
+        for annex_member in [annex_item for annex_item in warnet_content.get(PLUGIN_ANNEX)]:
+            assert annex_member in {
+                item.value for item in AnnexMember
+            }, f"{annex_member} is not a valid AnnexMember"
+
+    warnet_content[WarnetContent.HOOK_VALUE.value] = HookValue(hook_value)
+
+    _entrypoint(ctx, plugin_content, warnet_content)
+
+
+def _entrypoint(ctx, plugin_content: dict, warnet_content: dict):
+    """Called by entrypoint"""
+    hook_value = warnet_content[WarnetContent.HOOK_VALUE.value]
+
+    match hook_value:
+        case (
+            HookValue.PRE_NETWORK
+            | HookValue.POST_NETWORK
+            | HookValue.PRE_DEPLOY
+            | HookValue.POST_DEPLOY
+        ):
+            data = get_data(plugin_content)
+            if data:
+                _launch_circuit_breaker(ctx, node_name=hook_value.value.lower())
+            else:
+                _launch_circuit_breaker(ctx, node_name=hook_value.value.lower())
+        case HookValue.PRE_NODE:
+            name = warnet_content[PLUGIN_ANNEX][AnnexMember.NODE_NAME.value] + "-pre-pod"
+            _launch_circuit_breaker(ctx, node_name=hook_value.value.lower() + "-" + name)
+        case HookValue.POST_NODE:
+            name = warnet_content[PLUGIN_ANNEX][AnnexMember.NODE_NAME.value] + "-post-pod"
+            _launch_circuit_breaker(ctx, node_name=hook_value.value.lower() + "-" + name)
+            
+def get_data(plugin_content: dict) -> Optional[dict]:
+    data = {
+        key: plugin_content.get(key)
+        for key in (PluginContent.MAX_PENDING_HTLCS.value, PluginContent.RATE_LIMIT.value)
+        if plugin_content.get(key)
+    }
+    return data or None
+
+
+def _launch_circuit_breaker(ctx, node_name: str):
+    timestamp = int(time.time())
+    release_name = f"cb-{node_name}-{timestamp}"
+    
+    command = f"helm upgrade --install {node_name} {ctx.obj[PLUGIN_DIR_TAG]}/charts/circuitbreaker --set node={node_name}"
+    
+    log.info(command)
+    log.info(run_command(command))
+
+
+if __name__ == "__main__":
+    circuitbreaker()