From 28336709b86a77547dd153c4c405cfd7615bfb56 Mon Sep 17 00:00:00 2001 From: Arne Welzel Date: Thu, 3 Nov 2022 14:00:31 +0100 Subject: [PATCH] cluster: Add warning about cluster-layout.zeek content Relates to #2528, #991. --- scripts/base/frameworks/cluster/main.zeek | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/scripts/base/frameworks/cluster/main.zeek b/scripts/base/frameworks/cluster/main.zeek index 050499c1af..8cf0ef7abd 100644 --- a/scripts/base/frameworks/cluster/main.zeek +++ b/scripts/base/frameworks/cluster/main.zeek @@ -5,6 +5,14 @@ ##! The ``CLUSTER_NODE`` environment variable or :zeek:id:`Cluster::node` ##! must also be sent and the cluster framework loaded as a package like ##! ``@load base/frameworks/cluster``. +##! +##! .. warning:: +##! The file ``cluster-layout.zeek`` should only contain the definition +##! of :zeek:id:`Cluster::nodes`. Specifically, avoid loading other Zeek +##! scripts or using :zeek:see:`redef` for anything but :zeek:id:`Cluster::nodes`. +##! +##! Due to ``cluster-layout.zeek`` being loaded very early, it is easy to +##! introduce circular loading issues. @load base/frameworks/control @load base/frameworks/broker