feat(helmbroker): support raw_values in parameters

Author: jianxiaoguo

rootfs/helmbroker/tasks.py

@@ -2,6 +2,7 @@
 import time
 import shutil
 import yaml
+import base64
 import logging
 
 from openbrokerapi.service_broker import ProvisionDetails, OperationState, \
@@ -10,7 +11,7 @@
 from .celery import app
 from .utils import get_plan_path, get_chart_path, get_cred_value, \
     InstanceLock, dump_instance_meta, dump_binding_meta, load_instance_meta, \
-    get_instance_file, helm
+    get_instance_file, helm, dump_raw_values
 
 logger = logging.getLogger(__name__)
 
@@ -45,11 +46,16 @@ def provision(instance_id: str, details: ProvisionDetails):
             "--set",
             f"fullnameOverride=helmbroker-{details.context['instance_name']}"
         ]
-
-        for k, v in details.parameters:
-            args.extend(["--set", f"{k}={v}"])
         logger.info(f"helm install parameters :{details.parameters}")
-        logger.info(f"helm install parameters type:{type(details.parameters)}")
+        if details.parameters and "rawValues" in details.parameters \
+                and details.parameters.get("rawValues", ""):
+            values = str(base64.b64decode(details.parameters["rawValues"]), "utf-8")  # noqa
+            raw_values_file = dump_raw_values(instance_id, values)
+            args.extend(["-f", raw_values_file])
+            details.parameters.pop("rawValues")
+        for k, v in details.parameters.items():
+            args.extend(["--set", f"{k}={v}"])
+        logger.info(f"helm install args:{args}")
         status, output = helm(instance_id, *args)
         data = load_instance_meta(instance_id)
         if status != 0:
@@ -92,15 +98,22 @@ def update(instance_id: str, details: UpdateDetails):
         "--wait",
         "--timeout",
         "25m0s",
+        "--reuse-values",
         "-f",
         values_file,
         "--set",
         f"fullnameOverride=helmbroker-{details.context['instance_name']}"
     ]
-    for k, v in details.parameters:
-        args.extend(["--set", f"{k}={v}"])
     logger.info(f"helm upgrade parameters: {details.parameters}")
-    logger.info(f"helm upgrade parameters type: {type(details.parameters)}")
+    if details.parameters and "rawValues" in details.parameters \
+            and details.parameters.get("rawValues", ""):
+        values = str(base64.b64decode(details.parameters["rawValues"]), "utf-8")  # noqa
+        raw_values_file = dump_raw_values(instance_id, values)
+        args.extend(["-f", raw_values_file])
+        details.parameters.pop("rawValues")
+    for k, v in details.parameters.items():
+        args.extend(["--set", f"{k}={v}"])
+    logger.info(f"helm upgrade args:{args}")
     status, output = helm(instance_id, *args)
     if status != 0:
         data["last_operation"]["state"] = OperationState.FAILED.value

rootfs/helmbroker/utils.py

@@ -4,6 +4,8 @@
 import json
 import subprocess
 import time
+import base64
+import copy
 
 from jsonschema import validate
 from .config import INSTANCES_PATH, ADDONS_PATH
@@ -91,6 +93,15 @@ def dump_instance_meta(instance_id, data):
         f.write(json.dumps(data, sort_keys=True, indent=2))
 
 
+def dump_raw_values(instance_id, data):
+    timestamp = time.time()
+    instance_path = get_instance_path(instance_id)
+    file = f"{instance_path}/raw-values-{timestamp}.yaml"
+    with open(file, "w") as f:
+        f.write(data)
+    return file
+
+
 BINDING_META_SCHEMA = {
     "type": "object",
     "properties": {
@@ -217,7 +228,7 @@ def get_addon_bindable(service_id):
     return service.get('bindable', False)
 
 
-def get_addon_allow_parameters(service_id):
+def get_addon_allow_paras(service_id):
     service = get_addon_meta(service_id)
     return service.get('allow_parameters', [])
 
@@ -282,14 +293,39 @@ def verify_parameters(allow_paras, paras):
     """verify parameters allowed or not"""
     if not paras or not allow_paras:
         return ""
-    else:
-        not_allow_paras = []
-        allow_para_keys = [allow_para["name"] + "." for allow_para in allow_paras] # noqa
-        para_keys = [k + "." for k in paras]
-        for para_key in para_keys:
-            for allow_para_key in allow_para_keys:
-                # sub string Inclusion relationship
-                if not para_key.startswith(allow_para_key):
-                    not_allow_paras.append(para_key)
-        not_allow_keys = ",".split(not_allow_paras)
-        return not_allow_keys
+    tmp_paras = copy.deepcopy(paras)
+    # raw_values
+    raw_para_keys = []
+    if "rawValues" in tmp_paras:
+        raw_values = yaml.safe_load(base64.b64decode(tmp_paras["rawValues"]))
+        raw_para_keys = raw_values_format_keys(raw_values)
+        tmp_paras.pop("rawValues")
+
+    para_keys = set(list(tmp_paras.keys()) + raw_para_keys)
+    para_keys = [k + "." for k in para_keys]
+    allow_para_keys = [allow_para["name"] + "." for allow_para in allow_paras]  # noqa
+
+    not_allow_paras = []
+    for para_key in para_keys:
+        for allow_para_key in allow_para_keys:
+            # sub string, inclusion relationship
+            if not para_key.startswith(allow_para_key):
+                not_allow_paras.append(para_key)
+    not_allow_keys = ",".join(not_allow_paras)
+    return not_allow_keys
+
+
+def raw_values_format_keys(raw_values, prefix=''):
+    """
+    {'a': {'b': 1, 'c': {'d': 2, 'e': 3}}, 'f': 4}
+    ->
+    ['a.b', 'a.c.d', 'a.c.e', 'a.f']
+    """
+    keys = []
+    for key, value in raw_values.items():
+        new_prefix = prefix + '.' + key if prefix else key
+        if isinstance(value, dict):
+            keys.extend(raw_values_format_keys(value, new_prefix))
+        else:
+            keys.append(new_prefix)
+    return keys