feat!: add node selectors features (#491)

Co-authored-by: pk910 <github@pk910.de> Co-authored-by: parithosh <parithosh.jayanthi@ethereum.org> Co-authored-by: Gyanendra Mishra <anomaly.the@gmail.com>
ethpandaops · Feb 18, 2024 · 3ec7423 · 3ec7423
1 parent 7854d77
commit 3ec7423
Show file tree

Hide file tree

Showing 39 changed files with 387 additions and 91 deletions.
diff --git a/.github/tests/node-selectors.yaml b/.github/tests/node-selectors.yaml
@@ -0,0 +1,13 @@
+participants:
+  - el_client_type: reth
+    cl_client_type: teku
+    cl_split_mode_enabled: true
+    node_selectors: {
+      "kubernetes.io/hostname": testing-1,
+    }
+  - el_client_type: reth
+    cl_client_type: teku
+    cl_split_mode_enabled: true
+global_node_selectors: {
+  "kubernetes.io/hostname": testing-2,
+}
diff --git a/README.md b/README.md
@@ -264,6 +264,12 @@ participants:
   # Defaults to empty
   tolerations: []
 
+  # Node selector
+  # Only works with Kubernetes
+  # Example: node_selectors: { "disktype": "ssd" }
+  # Defaults to empty
+  node_selectors: {}
+
   # A list of optional extra params that will be passed to the CL client Beacon container for modifying its behaviour
   # If the client combines the Beacon & validator nodes (e.g. Teku, Nimbus), then this list will be passed to the combined Beacon-validator node
   beacon_extra_params: []
@@ -607,6 +613,12 @@ xatu_sentry_params:
 #   toleration_seconds: 3600
 # Defaults to empty
 global_tolerations: []
+
+# Global node selector that will be passed to all containers (unless overridden by a more specific node selector)
+# Only works with Kubernetes
+# Example: node_selectors: { "disktype": "ssd" }
+# Defaults to empty
+node_selectors: {}
 ```
 
 #### Example configurations

diff --git a/main.star b/main.star
@@ -60,6 +60,7 @@ def run(plan, args={}):
     persistent = args_with_right_defaults.persistent
     xatu_sentry_params = args_with_right_defaults.xatu_sentry_params
     global_tolerations = args_with_right_defaults.global_tolerations
+    global_node_selectors = args_with_right_defaults.global_node_selectors
 
     grafana_datasource_config_template = read_file(
         static_files.GRAFANA_DATASOURCE_CONFIG_TEMPLATE_FILEPATH
@@ -94,6 +95,7 @@ def run(plan, args={}):
         persistent,
         xatu_sentry_params,
         global_tolerations,
+        global_node_selectors,
         parallel_keystore_generation,
     )
 
@@ -136,7 +138,9 @@ def run(plan, args={}):
     if "broadcaster" in args_with_right_defaults.additional_services:
         args_with_right_defaults.additional_services.remove("broadcaster")
         broadcaster_service = broadcaster.launch_broadcaster(
-            plan, all_el_client_contexts
+            plan,
+            all_el_client_contexts,
+            global_node_selectors,
         )
         fuzz_target = "http://{0}:{1}".format(
             broadcaster_service.ip_address,
@@ -169,6 +173,7 @@ def run(plan, args={}):
             beacon_uri,
             raw_jwt_secret,
             args_with_right_defaults.global_client_log_level,
+            global_node_selectors,
         )
         mev_endpoints.append(endpoint)
     elif (
@@ -194,6 +199,7 @@ def run(plan, args={}):
             fuzz_target,
             contract_owner.private_key,
             normal_user.private_key,
+            global_node_selectors,
         )
         epoch_recipe = GetHttpRequestRecipe(
             endpoint="/eth/v2/beacon/blocks/head",
@@ -217,6 +223,7 @@ def run(plan, args={}):
             builder_uri,
             network_params.seconds_per_slot,
             persistent,
+            global_node_selectors,
         )
         mev_flood.spam_in_background(
             plan,
@@ -237,7 +244,8 @@ def run(plan, args={}):
             )
             if args_with_right_defaults.participants[index].validator_count != 0:
                 mev_boost_launcher = mev_boost.new_mev_boost_launcher(
-                    MEV_BOOST_SHOULD_CHECK_RELAY, mev_endpoints
+                    MEV_BOOST_SHOULD_CHECK_RELAY,
+                    mev_endpoints,
                 )
                 mev_boost_service_name = "{0}-{1}-{2}-{3}".format(
                     input_parser.MEV_BOOST_SERVICE_NAME_PREFIX,
@@ -252,6 +260,7 @@ def run(plan, args={}):
                     network_params.network_id,
                     mev_params.mev_boost_image,
                     mev_params.mev_boost_args,
+                    global_node_selectors,
                 )
                 all_mevboost_contexts.append(mev_boost_context)
 
@@ -275,6 +284,7 @@ def run(plan, args={}):
                 fuzz_target,
                 tx_spammer_params,
                 network_params.electra_fork_epoch,
+                global_node_selectors,
             )
             plan.print("Successfully launched transaction spammer")
         elif additional_service == "blob_spammer":
@@ -287,6 +297,7 @@ def run(plan, args={}):
                 network_params.deneb_fork_epoch,
                 network_params.seconds_per_slot,
                 network_params.genesis_delay,
+                global_node_selectors,
             )
             plan.print("Successfully launched blob spammer")
         elif additional_service == "goomy_blob":
@@ -299,6 +310,7 @@ def run(plan, args={}):
                 all_cl_client_contexts[0],
                 network_params.seconds_per_slot,
                 goomy_blob_params,
+                global_node_selectors,
             )
             plan.print("Successfully launched goomy the blob spammer")
         # We need a way to do time.sleep
@@ -309,7 +321,10 @@ def run(plan, args={}):
                 static_files.EL_FORKMON_CONFIG_TEMPLATE_FILEPATH
             )
             el_forkmon.launch_el_forkmon(
-                plan, el_forkmon_config_template, all_el_client_contexts
+                plan,
+                el_forkmon_config_template,
+                all_el_client_contexts,
+                global_node_selectors,
             )
             plan.print("Successfully launched execution layer forkmon")
         elif additional_service == "beacon_metrics_gazer":
@@ -319,6 +334,7 @@ def run(plan, args={}):
                     plan,
                     all_cl_client_contexts,
                     network_params,
+                    global_node_selectors,
                 )
             )
             launch_prometheus_grafana = True
@@ -329,7 +345,10 @@ def run(plan, args={}):
         elif additional_service == "blockscout":
             plan.print("Launching blockscout")
             blockscout_sc_verif_url = blockscout.launch_blockscout(
-                plan, all_el_client_contexts, persistent
+                plan,
+                all_el_client_contexts,
+                persistent,
+                global_node_selectors,
             )
             plan.print("Successfully launched blockscout")
         elif additional_service == "dora":
@@ -342,6 +361,7 @@ def run(plan, args={}):
                 el_cl_data_files_artifact_uuid,
                 network_params.electra_fork_epoch,
                 network_params.network,
+                global_node_selectors,
             )
             plan.print("Successfully launched dora")
         elif additional_service == "blobscan":
@@ -352,6 +372,7 @@ def run(plan, args={}):
                 all_el_client_contexts,
                 network_params.network_id,
                 persistent,
+                global_node_selectors,
             )
             plan.print("Successfully launched blobscan")
         elif additional_service == "full_beaconchain_explorer":
@@ -365,6 +386,7 @@ def run(plan, args={}):
                 all_cl_client_contexts,
                 all_el_client_contexts,
                 persistent,
+                global_node_selectors,
             )
             plan.print("Successfully launched full-beaconchain-explorer")
         elif additional_service == "prometheus_grafana":
@@ -383,6 +405,7 @@ def run(plan, args={}):
                 args_with_right_defaults.participants,
                 network_params,
                 assertoor_params,
+                global_node_selectors,
             )
             plan.print("Successfully launched assertoor")
         elif additional_service == "custom_flood":
@@ -392,6 +415,7 @@ def run(plan, args={}):
                 genesis_constants.PRE_FUNDED_ACCOUNTS[0].address,
                 fuzz_target,
                 args_with_right_defaults.custom_flood_params,
+                global_node_selectors,
             )
         else:
             fail("Invalid additional service %s" % (additional_service))
@@ -404,6 +428,7 @@ def run(plan, args={}):
             prometheus_additional_metrics_jobs,
             all_ethereum_metrics_exporter_contexts,
             all_xatu_sentry_contexts,
+            global_node_selectors,
         )
 
         plan.print("Launching grafana...")
@@ -412,6 +437,7 @@ def run(plan, args={}):
             grafana_datasource_config_template,
             grafana_dashboards_config_template,
             prometheus_private_url,
+            global_node_selectors,
             additional_dashboards=args_with_right_defaults.grafana_additional_dashboards,
         )
         plan.print("Successfully launched grafana")

diff --git a/network_params.yaml b/network_params.yaml
@@ -11,6 +11,7 @@ participants:
     cl_tolerations: []
     validator_tolerations: []
     tolerations: []
+    node_selectors: {}
     beacon_extra_params: []
     beacon_extra_labels: {}
     validator_extra_params: []
@@ -89,3 +90,4 @@ grafana_additional_dashboards: []
 persistent: false
 xatu_sentry_enabled: false
 global_tolerations: []
+global_node_selectors: {}
diff --git a/src/assertoor/assertoor_launcher.star b/src/assertoor/assertoor_launcher.star
@@ -36,6 +36,7 @@ def launch_assertoor(
     participant_configs,
     network_params,
     assertoor_params,
+    global_node_selectors,
 ):
     all_client_info = []
     validator_client_info = []
@@ -91,6 +92,7 @@ def launch_assertoor(
         tests_config_artifacts_name,
         network_params,
         assertoor_params,
+        global_node_selectors,
     )
 
     plan.add_service(SERVICE_NAME, config)
@@ -101,6 +103,7 @@ def get_config(
     tests_config_artifacts_name,
     network_params,
     assertoor_params,
+    node_selectors,
 ):
     config_file_path = shared_utils.path_join(
         ASSERTOOR_CONFIG_MOUNT_DIRPATH_ON_SERVICE,
@@ -127,6 +130,7 @@ def get_config(
         max_cpu=MAX_CPU,
         min_memory=MIN_MEMORY,
         max_memory=MAX_MEMORY,
+        node_selectors=node_selectors,
     )
 
 

diff --git a/src/beacon_metrics_gazer/beacon_metrics_gazer_launcher.star b/src/beacon_metrics_gazer/beacon_metrics_gazer_launcher.star
@@ -31,10 +31,16 @@ MIN_MEMORY = 20
 MAX_MEMORY = 300
 
 
-def launch_beacon_metrics_gazer(plan, cl_client_contexts, network_params):
+def launch_beacon_metrics_gazer(
+    plan,
+    cl_client_contexts,
+    network_params,
+    global_node_selectors,
+):
     config = get_config(
         cl_client_contexts[0].ip_addr,
         cl_client_contexts[0].http_port_num,
+        global_node_selectors,
     )
 
     beacon_metrics_gazer_service = plan.add_service(SERVICE_NAME, config)
@@ -51,7 +57,7 @@ def launch_beacon_metrics_gazer(plan, cl_client_contexts, network_params):
     )
 
 
-def get_config(ip_addr, http_port_num):
+def get_config(ip_addr, http_port_num, node_selectors):
     config_file_path = shared_utils.path_join(
         BEACON_METRICS_GAZER_CONFIG_MOUNT_DIRPATH_ON_SERVICE,
         BEACON_METRICS_GAZER_CONFIG_FILENAME,
@@ -76,4 +82,5 @@ def get_config(ip_addr, http_port_num):
         max_cpu=MAX_CPU,
         min_memory=MIN_MEMORY,
         max_memory=MAX_MEMORY,
+        node_selectors=node_selectors,
     )
diff --git a/src/blob_spammer/blob_spammer.star b/src/blob_spammer/blob_spammer.star
@@ -18,6 +18,7 @@ def launch_blob_spammer(
     deneb_fork_epoch,
     seconds_per_slot,
     genesis_delay,
+    global_node_selectors,
 ):
     config = get_config(
         prefunded_addresses,
@@ -26,6 +27,7 @@ def launch_blob_spammer(
         deneb_fork_epoch,
         seconds_per_slot,
         genesis_delay,
+        global_node_selectors,
     )
     plan.add_service(SERVICE_NAME, config)
 
@@ -37,6 +39,7 @@ def get_config(
     deneb_fork_epoch,
     seconds_per_slot,
     genesis_delay,
+    node_selectors,
 ):
     dencunTime = (deneb_fork_epoch * 32 * seconds_per_slot) + genesis_delay
     return ServiceConfig(
@@ -68,4 +71,5 @@ def get_config(
         max_cpu=MAX_CPU,
         min_memory=MIN_MEMORY,
         max_memory=MAX_MEMORY,
+        node_selectors=node_selectors,
     )
diff --git a/src/blobber/blobber_launcher.star b/src/blobber/blobber_launcher.star
@@ -35,11 +35,22 @@ MIN_MEMORY = 10
 MAX_MEMORY = 300
 
 
-def launch(plan, service_name, node_keystore_files, beacon_http_url, extra_params):
+def launch(
+    plan,
+    service_name,
+    node_keystore_files,
+    beacon_http_url,
+    extra_params,
+    node_selectors,
+):
     blobber_service_name = "{0}".format(service_name)
 
     blobber_config = get_config(
-        service_name, node_keystore_files, beacon_http_url, extra_params
+        service_name,
+        node_keystore_files,
+        beacon_http_url,
+        extra_params,
+        node_selectors,
     )
 
     blobber_service = plan.add_service(blobber_service_name, blobber_config)
@@ -49,7 +60,13 @@ def launch(plan, service_name, node_keystore_files, beacon_http_url, extra_param
     )
 
 
-def get_config(service_name, node_keystore_files, beacon_http_url, extra_params):
+def get_config(
+    service_name,
+    node_keystore_files,
+    beacon_http_url,
+    extra_params,
+    node_selectors,
+):
     validator_root_dirpath = shared_utils.path_join(
         VALIDATOR_KEYS_MOUNTPOINT_ON_CLIENTS,
         node_keystore_files.raw_root_dirpath,
@@ -78,4 +95,5 @@ def get_config(service_name, node_keystore_files, beacon_http_url, extra_params)
         max_cpu=MAX_CPU,
         min_memory=MIN_MEMORY,
         max_memory=MAX_MEMORY,
+        node_selectors=node_selectors,
     )