From d122894d0dd2b6fffff70ab46840fcf174bedf50 Mon Sep 17 00:00:00 2001
From: Arne Welzel <arne.welzel@corelight.com>
Date: Thu, 25 Sep 2025 18:10:38 +0200
Subject: [PATCH] cluster: Rename setup-connections to setup-subscriptions

Now that all the logic about establishing connections among nodes has
moved to the broker policy script, the setup-connections name seems
unfortunate, transition away from it.
---
 scripts/base/frameworks/cluster/__load__.zeek |  2 +-
 scripts/base/frameworks/cluster/pools.zeek    |  2 +-
 .../frameworks/cluster/setup-connections.zeek | 49 +------------------
 .../cluster/setup-subscriptions.zeek          | 46 +++++++++++++++++
 .../Baseline/coverage.bare-mode-errors/errors |  1 +
 .../coverage.init-default/missing_loads       |  1 +
 6 files changed, 52 insertions(+), 49 deletions(-)
 create mode 100644 scripts/base/frameworks/cluster/setup-subscriptions.zeek

diff --git a/scripts/base/frameworks/cluster/__load__.zeek b/scripts/base/frameworks/cluster/__load__.zeek
index 2ca60fb67a..a7c200b16c 100644
--- a/scripts/base/frameworks/cluster/__load__.zeek
+++ b/scripts/base/frameworks/cluster/__load__.zeek
@@ -43,7 +43,7 @@ redef Cluster::manager_is_logger = F;
 
 @if ( Cluster::node in Cluster::nodes )
 
-@load ./setup-connections
+@load ./setup-subscriptions
 
 @if ( Cluster::local_node_type() == Cluster::MANAGER )
 @load ./nodes/manager
diff --git a/scripts/base/frameworks/cluster/pools.zeek b/scripts/base/frameworks/cluster/pools.zeek
index 418706b554..effb491d10 100644
--- a/scripts/base/frameworks/cluster/pools.zeek
+++ b/scripts/base/frameworks/cluster/pools.zeek
@@ -346,7 +346,7 @@ function pool_sorter(a: Pool, b: Pool): int
 	return strcmp(a$spec$topic, b$spec$topic);
 	}
 
-# Needs to execute before the zeek_init in setup-connections
+# Needs to execute before the zeek_init in setup-subscriptions
 event zeek_init() &priority=-5
 	{
 	if ( ! Cluster::is_enabled() )
diff --git a/scripts/base/frameworks/cluster/setup-connections.zeek b/scripts/base/frameworks/cluster/setup-connections.zeek
index ea67b5115a..ef373ecf47 100644
--- a/scripts/base/frameworks/cluster/setup-connections.zeek
+++ b/scripts/base/frameworks/cluster/setup-connections.zeek
@@ -1,48 +1,3 @@
-##! This script establishes communication among all nodes in a cluster
-##! as defined by :zeek:id:`Cluster::nodes`.
+@deprecated "Remove in v9.1: Load base/frameworks/cluster/setup-subscriptions instead"
 
-@load ./main
-@load ./pools
-
-module Cluster;
-
-event zeek_init() &priority=-5
-	{
-	if ( getenv("ZEEKCTL_CHECK_CONFIG") != "" )
-		return;
-
-	local self = nodes[node];
-
-	for ( i in registered_pools )
-		{
-		local pool = registered_pools[i];
-
-		if ( node in pool$nodes )
-			Cluster::subscribe(pool$spec$topic);
-		}
-
-	switch ( self$node_type ) {
-	case NONE:
-		return;
-	case CONTROL:
-		break;
-	case LOGGER:
-		Cluster::subscribe(Cluster::logger_topic);
-		break;
-	case MANAGER:
-		Cluster::subscribe(Cluster::manager_topic);
-		break;
-	case PROXY:
-		Cluster::subscribe(Cluster::proxy_topic);
-		break;
-	case WORKER:
-		Cluster::subscribe(Cluster::worker_topic);
-		break;
-	default:
-		Reporter::error(fmt("Unhandled cluster node type: %s", self$node_type));
-		return;
-	}
-
-	Cluster::subscribe(nodeid_topic(Cluster::node_id()));
-	Cluster::subscribe(node_topic(node));
-	}
+@load ./setup-subscriptions
diff --git a/scripts/base/frameworks/cluster/setup-subscriptions.zeek b/scripts/base/frameworks/cluster/setup-subscriptions.zeek
new file mode 100644
index 0000000000..9aef5f302b
--- /dev/null
+++ b/scripts/base/frameworks/cluster/setup-subscriptions.zeek
@@ -0,0 +1,46 @@
+##! This script contains the common subscription setup logic.
+@load ./main
+@load ./pools
+
+module Cluster;
+
+event zeek_init() &priority=-5
+	{
+	if ( getenv("ZEEKCTL_CHECK_CONFIG") != "" )
+		return;
+
+	local self = nodes[node];
+
+	for ( i in registered_pools )
+		{
+		local pool = registered_pools[i];
+
+		if ( node in pool$nodes )
+			Cluster::subscribe(pool$spec$topic);
+		}
+
+	switch ( self$node_type ) {
+	case NONE:
+		return;
+	case CONTROL:
+		break;
+	case LOGGER:
+		Cluster::subscribe(Cluster::logger_topic);
+		break;
+	case MANAGER:
+		Cluster::subscribe(Cluster::manager_topic);
+		break;
+	case PROXY:
+		Cluster::subscribe(Cluster::proxy_topic);
+		break;
+	case WORKER:
+		Cluster::subscribe(Cluster::worker_topic);
+		break;
+	default:
+		Reporter::error(fmt("Unhandled cluster node type: %s", self$node_type));
+		return;
+	}
+
+	Cluster::subscribe(nodeid_topic(Cluster::node_id()));
+	Cluster::subscribe(node_topic(node));
+	}
diff --git a/testing/btest/Baseline/coverage.bare-mode-errors/errors b/testing/btest/Baseline/coverage.bare-mode-errors/errors
index b1bb951e92..5ed62ac0af 100644
--- a/testing/btest/Baseline/coverage.bare-mode-errors/errors
+++ b/testing/btest/Baseline/coverage.bare-mode-errors/errors
@@ -1,2 +1,3 @@
 ### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63.
 ### NOTE: This file has been sorted with diff-sort.
+warning in <...>/setup-connections.zeek, line 1: deprecated script loaded from command line arguments "Remove in v9.1: Load base<...>/setup-subscriptions instead"
diff --git a/testing/btest/Baseline/coverage.init-default/missing_loads b/testing/btest/Baseline/coverage.init-default/missing_loads
index 93af34614e..44c9f1ea1f 100644
--- a/testing/btest/Baseline/coverage.init-default/missing_loads
+++ b/testing/btest/Baseline/coverage.init-default/missing_loads
@@ -7,6 +7,7 @@
 -./frameworks/cluster/nodes/proxy.zeek
 -./frameworks/cluster/nodes/worker.zeek
 -./frameworks/cluster/setup-connections.zeek
+-./frameworks/cluster/setup-subscriptions.zeek
 -./frameworks/cluster/supervisor.zeek
 -./frameworks/intel/cluster.zeek
 -./frameworks/netcontrol/cluster.zeek