Merge remote-tracking branch 'origin/topic/awelzel/2528-cluster-layout-content-warning'

* origin/topic/awelzel/2528-cluster-layout-content-warning:
  cluster: Add warning about cluster-layout.zeek content
This commit is contained in:
Robin Sommer 2022-11-07 11:28:57 +01:00
commit 3a9320dab3
No known key found for this signature in database
GPG key ID: D8187293B3FFE5D0

View file

@ -5,6 +5,15 @@
##! The ``CLUSTER_NODE`` environment variable or :zeek:id:`Cluster::node` ##! The ``CLUSTER_NODE`` environment variable or :zeek:id:`Cluster::node`
##! must also be sent and the cluster framework loaded as a package like ##! must also be sent and the cluster framework loaded as a package like
##! ``@load base/frameworks/cluster``. ##! ``@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/control
@load base/frameworks/broker @load base/frameworks/broker