allow container params from config file

Author: ndeto

kurtosis.yml

@@ -1 +1 @@
-name: "github.com/punkhazardlabs/ethereum-package"
+name: "github.com/ethpandaops/ethereum-package"

main.star

@@ -89,7 +89,6 @@ def run(plan, args={}):
     keymanager_enabled = args_with_right_defaults.keymanager_enabled
     apache_port = args_with_right_defaults.apache_port
     docker_cache_params = args_with_right_defaults.docker_cache_params
-    txpool_viz_params = args_with_right_defaults.txpool_viz_params
 
     prefunded_accounts = genesis_constants.PRE_FUNDED_ACCOUNTS
     if (
@@ -486,7 +485,7 @@ def run(plan, args={}):
                 plan,
                 txpool_viz_config_template,
                 all_participants,
-                txpool_viz_params,
+                args_with_right_defaults.txpool_viz_params,
                 global_node_selectors
             )
         elif additional_service == "forkmon":

src/package_io/constants.star

@@ -93,6 +93,7 @@ MEV_RS_MEV_TYPE = "mev-rs"
 COMMIT_BOOST_MEV_TYPE = "commit-boost"
 DEFAULT_DORA_IMAGE = "ethpandaops/dora:latest"
 DEFAULT_SPAMOOR_IMAGE = "ethpandaops/spamoor:latest"
+DEFAULT_TXPOOL_VIZ_IMAGE = "punkhazardlabs/txpool-viz:latest"
 DEFAULT_ASSERTOOR_IMAGE = "ethpandaops/assertoor:latest"
 DEFAULT_SNOOPER_IMAGE = "ethpandaops/rpc-snooper:latest"
 DEFAULT_ETHEREUM_GENESIS_GENERATOR_IMAGE = (

src/package_io/input_parser.star

@@ -74,6 +74,7 @@ ATTR_TO_BE_SKIPPED_AT_ROOT = (
     "dora_params",
     "docker_cache_params",
     "assertoor_params",
+    "txpool_viz_params",
     "prometheus_params",
     "grafana_params",
     "tx_fuzz_params",
@@ -114,7 +115,6 @@ def input_parser(plan, input_args):
     result["global_node_selectors"] = {}
     result["port_publisher"] = get_port_publisher_params("default")
     result["spamoor_params"] = get_default_spamoor_params()
-    result["txpool_viz_params"] = get_txpool_viz_params(input_args)
 
     if constants.NETWORK_NAME.shadowfork in result["network_params"]["network"]:
         shadow_base = result["network_params"]["network"].split("-shadowfork")[0]
@@ -180,6 +180,8 @@ def input_parser(plan, input_args):
             for sub_attr in input_args["spamoor_params"]:
                 sub_value = input_args["spamoor_params"][sub_attr]
                 result["spamoor_params"][sub_attr] = sub_value
+        elif attr == "txpool_viz_params":
+            result["txpool_viz_params"] = get_txpool_viz_params(input_args)
         elif attr == "ethereum_genesis_generator_params":
             for sub_attr in input_args["ethereum_genesis_generator_params"]:
                 sub_value = input_args["ethereum_genesis_generator_params"][sub_attr]
@@ -537,6 +539,18 @@ def input_parser(plan, input_args):
             spammers=result["spamoor_params"]["spammers"],
             extra_args=result["spamoor_params"]["extra_args"],
         ),
+        txpool_viz_params=struct(
+            image=result["txpool_viz_params"]["image"],
+            min_cpu=result["txpool_viz_params"]["min_cpu"],
+            max_cpu=result["txpool_viz_params"]["max_cpu"],
+            min_mem=result["txpool_viz_params"]["min_mem"],
+            max_mem=result["txpool_viz_params"]["max_mem"],
+            extra_args=result["txpool_viz_params"]["extra_args"],
+            polling=result["txpool_viz_params"]["polling"],
+            filters=result["txpool_viz_params"]["filters"],
+            focil_enabled=result["txpool_viz_params"]["focil_enabled"],
+            log_level=result["txpool_viz_params"]["log_level"],
+        ),
         additional_services=result["additional_services"],
         wait_for_finalization=result["wait_for_finalization"],
         global_log_level=result["global_log_level"],
@@ -587,10 +601,7 @@ def input_parser(plan, input_args):
                 "public_port_start"
             ],
         ),
-        txpool_viz_params=result["txpool_viz_params"]
     )
-
-
 def parse_network_params(plan, input_args):
     result = default_input_args(input_args)
     if input_args.get("network_params", {}).get("preset") == "minimal":
@@ -1676,8 +1687,15 @@ def get_default_ethereum_genesis_generator_params():
         "image": constants.DEFAULT_ETHEREUM_GENESIS_GENERATOR_IMAGE,
     }
 def get_txpool_viz_params(input_args):
+    min_cpu = input_args.get("txpool_viz_params", {}).get("min_cpu", False)
+    max_cpu = input_args.get("txpool_viz_params", {}).get("max_cpu", False)
+    min_mem = input_args.get("txpool_viz_params", {}).get("min_mem", False)
+    max_mem = input_args.get("txpool_viz_params", {}).get("max_mem", False)
+    extra_args = input_args.get("txpool_viz_params", {}).get("extra_args", [])
     polling_args = input_args.get("txpool_viz_params", {}).get("polling", {})
     filters_args = input_args.get("txpool_viz_params", {}).get("filters", {})
+    focil_enabled = input_args.get("txpool_viz_params", {}).get("focil_enabled", "false")
+    log_level = input_args.get("txpool_viz_params", {}).get("log_level", "info")
 
     polling_config = {
         "interval": polling_args.get("interval", "0.5s"),
@@ -1688,14 +1706,16 @@ def get_txpool_viz_params(input_args):
         "min_gas_price": filters_args.get("min_gas_price", "1gwei"),
     }
 
-    focil_enabled = filters_args.get("focil_enabled", "false")
-
-    log_level = filters_args.get("log_level", "info")
-
     return {
+        "image": constants.DEFAULT_TXPOOL_VIZ_IMAGE,
+        "min_cpu": min_cpu,
+        "max_cpu": max_cpu,
+        "min_mem": min_mem,
+        "max_mem": max_mem,
+        "extra_args": extra_args,
         "polling": polling_config,
         "filters": filters_config,
         "focil_enabled": focil_enabled,
-        "log_level": log_level
+        "log_level": log_level,
     }
 

src/package_io/sanity_check.star

@@ -300,6 +300,11 @@ SUBCATEGORY_PARAMS = {
         "other",
     ],
     "txpool_viz_params": [
+        "min_cpu",
+        "max_cpu",
+        "min_mem",
+        "max_mem",
+        "extra_args",
         "polling",
         "filters",
         "focil_enabled",

src/txpool_viz/txpool_viz.star

@@ -8,23 +8,23 @@ TXPOOL_VIZ_SERVICE_NAME="txpool-viz"
 TXPOOL_VIZ_CONFIG_FILENAME = "config.yaml"
 TXPOOL_VIZ_CONFIG_PATH="/cfg/"
 
-# The min/max CPU/memory that txpool-viz can use
+# The min/max CPU/memory that txpool-viz can use.
 MIN_CPU = 100
-MAX_CPU = 10000
-MIN_MEMORY = 128
-MAX_MEMORY = 8192
+MAX_CPU = 1000
+MIN_MEM = 128
+MAX_MEM = 1024
 
 def launch_txpool_viz(
     plan,
     config_template,
     network_participants,
-    txpoolviz_params,
+    txpool_viz_params,
     global_node_selectors
 ):
-    endpoint_list = []
+    endpoints_list = []
     for participant in network_participants:
         el_metrics_info = participant.el_context.el_metrics_info
-        endpoint_list.append({
+        endpoints_list.append({
             "Name": el_metrics_info[0]["name"] if el_metrics_info else "unknown",
             "RPCUrl": participant.el_context.rpc_http_url,
             "Socket": participant.el_context.ws_url
@@ -37,14 +37,8 @@ def launch_txpool_viz(
             "BeaconUrl": participant.cl_context.beacon_http_url,
         })
 
-
-    txpoolviz_params["endpoints"] = endpoint_list
-    txpoolviz_params["beacon_endpoints"] = beacon_endpoints
-
-    txpoolviz_params["endpoints"] = endpoint_list
-
-    # // config data & template
-    template_data = txpool_viz_config_template_data(txpoolviz_params)
+    # config data & template
+    template_data = txpool_viz_config_template_data(txpool_viz_params, endpoints_list, beacon_endpoints)
 
     template_and_data = shared_utils.new_template_and_data(
         config_template, template_data
@@ -63,7 +57,7 @@ def launch_txpool_viz(
         service_name="txpool-viz-postgres",
     )
 
-    # add redis server
+    # attaching redis server
     redis = redis_module.run(
         plan,
         service_name="txpool-viz-redis",
@@ -78,41 +72,42 @@ def launch_txpool_viz(
           "ENV": "prod" # Default for Kurtosis
         }
 
-    service_config = get_service_config(environment_variables, txpoolviz_params, global_node_selectors, config_files_artifact_name)
+    service_config = get_service_config(environment_variables, txpool_viz_params, global_node_selectors, config_files_artifact_name)
 
     txpoolviz = plan.add_service(TXPOOL_VIZ_SERVICE_NAME, config=service_config)
 
 def get_service_config(environment_variables, txpool_viz_params, node_selectors, files_artifact):
     return ServiceConfig(
-        image="punkhazardlabs/txpool-viz:dev",
+        image=txpool_viz_params.image,
         ports= {
             shared_utils.HTTP_APPLICATION_PROTOCOL:  PortSpec(
                 number=HTTP_PORT_NUMBER,
                 application_protocol=shared_utils.HTTP_APPLICATION_PROTOCOL,
                 transport_protocol=shared_utils.TCP_PROTOCOL,
             ),
         },
-        env_vars = environment_variables,
-        min_cpu=MIN_CPU,
-        max_cpu=MAX_CPU,
-        min_memory=MIN_MEMORY,
-        max_memory=MAX_MEMORY,
+        env_vars=environment_variables,
+        min_cpu=txpool_viz_params.min_cpu or MIN_CPU,
+        max_cpu=txpool_viz_params.max_cpu or MAX_CPU,
+        min_memory=txpool_viz_params.min_mem or MIN_MEM,
+        max_memory=txpool_viz_params.max_mem or MAX_MEM,
         files = {
            TXPOOL_VIZ_CONFIG_PATH : files_artifact
         },
         node_selectors=node_selectors,
       )
 
-def txpool_viz_config_template_data(config):
+def txpool_viz_config_template_data(config, endpoints_list, beacon_endpoints):
     cfg = {
-        "Endpoints": config["endpoints"],
-        "Polling": config["polling"],
-        "Filters": config["filters"],
-        "LogLevel": config["log_level"],
+        "Endpoints": endpoints_list,
+        "Polling": config.polling,
+        "Filters": config.filters,
+        "LogLevel": config.log_level,
+        "ExtraArgs": config.extra_args
     }
 
-    if config["focil_enabled"] == "true":
-        cfg["FocilEnabled"]= config["focil_enabled"]
-        cfg["BeaconEndpoints"] = config["beacon_endpoints"]
+    if config.focil_enabled == "true":
+        cfg["FocilEnabled"] = config.focil_enabled
+        cfg["BeaconEndpoints"] = beacon_endpoints
 
     return cfg

static_files/txpool-viz-config/config.yaml.tmpl

@@ -22,3 +22,5 @@ filters:
   min_gas_price: {{ .Filters.MinGasPrice }}
 
 log_level: "{{ .LogLevel }}"
+
+extra_args: {{ .ExtraArgs }}