noc.config section

CHANGELOG.md

@@ -19,6 +19,7 @@ To see unreleased changes, please see the [CHANGELOG on the master branch](https
 ### Added
 
 * `restart` command.
+* `noc.config` section.
 
 ### Changed
 

src/gufo/thor/config.py

@@ -29,6 +29,7 @@ class NocConfig(object):
             in the interface.
         theme: Web interface theme. One of: `noc`, `gray`.
         migrate: Run migrations on start
+        config: User-defined config.
     """
 
     tag: str = "master"
@@ -37,6 +38,7 @@ class NocConfig(object):
     installation_name: str = "Unconfigured Installation"
     theme: Literal["noc", "gray"] = "noc"
     migrate: bool = True
+    config: Optional[Dict[str, Any]] = None
 
     @staticmethod
     def from_dict(data: Dict[str, Any]) -> "NocConfig":

src/gufo/thor/services/kafka.py

@@ -20,7 +20,7 @@ class KafkaService(BaseService):
     name = "kafka"
     compose_image = "bitnami/kafka:3.6.2"
     compose_volumes = [
-        "kafka_data:/data/",
+        "kafka_data:/bitnami/data/",
     ]
     compose_volumes_config = {"kafka_data": {}}
     service_discovery = {"kafka": 9093}

src/gufo/thor/services/noc.py

@@ -1,16 +1,20 @@
 # ---------------------------------------------------------------------
 # Gufo Thor: noc service
 # ---------------------------------------------------------------------
-# Copyright (C) 2023, Gufo Labs
+# Copyright (C) 2023-24, Gufo Labs
 # ---------------------------------------------------------------------
 """NocService base class."""
 
 # Python Modules
 from pathlib import Path
 from typing import Any, Dict, List, Optional
 
+# Third-party modules
+import yaml
+
 # Gufo Thor modules
 from ..config import Config, ServiceConfig
+from ..utils import merge_dict, write_file
 from .base import BaseService, ComposeDependsCondition
 
 
@@ -90,12 +94,27 @@ def prepare_compose_config(
         """
         if self._config_prepared:
             return  # Already configured from other subclass
-        NocService.render_file(
-            Path("etc", "noc", "settings.yml"),
-            "settings.yml",
-            installation_name=config.noc.installation_name,
-            theme=config.noc.theme,
-        )
+        # Build default config
+        cfg = {
+            "installation_name": config.noc.installation_name,
+            "pg": {
+                "db": "noc",
+                "user": "noc",
+                "password": "noc",
+            },
+            "web": {
+                "theme": config.noc.theme,
+            },
+            "msgstream": {
+                "client_class": "noc.core.msgstream.redpanda.RedPandaClient",
+            },
+            "redpanda": {"addresses": "kafka:9092"},
+        }
+        # Apply user config
+        if config.noc.config:
+            cfg = merge_dict(cfg, config.noc.config)
+        # Write
+        write_file(Path("etc", "noc", "settings.yml"), yaml.dump(cfg))
         self._config_prepared = True
 
     def get_compose_volumes_config(

src/gufo/thor/utils.py

@@ -1,15 +1,15 @@
 # ---------------------------------------------------------------------
 # Gufo Thor: Various utilities
 # ---------------------------------------------------------------------
-# Copyright (C) 2023, Gufo Labs
+# Copyright (C) 2023--24, Gufo Labs
 # ---------------------------------------------------------------------
 """Various utilities."""
 
 # Python modules
 import os
 import shutil
 from pathlib import Path
-from typing import Optional, Union
+from typing import Any, Dict, Optional, Union
 
 # Gufo Thor modules
 from .log import logger
@@ -59,3 +59,35 @@ def ensure_directory(path: Path) -> None:
         return
     logger.warning("Creating directory %s", path)
     os.makedirs(path)
+
+
+def merge_dict(x: Dict[str, Any], y: Dict[str, Any]) -> Dict[str, Any]:
+    """
+    Deep merge dictionaries.
+
+    Do not affect source dictionaries.
+    Second dictionary overrides first.
+
+    Args:
+        x: First dictionary.
+        y: Second dictionary.
+
+    Returns:
+        Merged dictionary.
+    """
+    r: Dict[str, Any] = {}
+    xk = set(x)
+    yk = set(y)
+    # Append keys which are only in first dictionary
+    for k in xk - yk:
+        r[k] = x[k]
+    # Append keys which are only in second dictionary
+    for k in yk - xk:
+        r[k] = y[k]
+    # Merge overlapped keys
+    for k in xk.intersection(yk):
+        if isinstance(x[k], dict) and isinstance(y[k], dict):
+            r[k] = merge_dict(x[k], y[k])
+        else:
+            r[k] = y[k]
+    return r