Management framework: comment and layouting tweaks, no functional change

Also remove additional instances of the term "data cluster".
This commit is contained in:
Christian Kreibich 2022-05-12 13:07:03 -07:00
parent d4d6f10299
commit bd6c1683a2
5 changed files with 13 additions and 8 deletions

View file

@ -55,12 +55,12 @@ export {
$address="0.0.0.0", $bound_port=0/unknown] &redef;
## An optional custom output directory for stdout/stderr. Agent and
## controller currently only log locally, not via the data cluster's
## controller currently only log locally, not via the Zeek cluster's
## logger node. This means that if both write to the same log file,
## output gets garbled.
const directory = "" &redef;
## The working directory for data cluster nodes created by this
## The working directory for Zeek cluster nodes created by this
## agent. If you make this a relative path, note that the path is
## relative to the agent's working directory, since it creates data
## cluster nodes.

View file

@ -172,7 +172,13 @@ event Management::Agent::API::set_configuration_request(reqid: string, config: M
g_cluster[node$name] = cep;
}
# Apply the new configuration via the supervisor
# Apply the new configuration via the supervisor.
#
# XXX this should launch in the nodes in controlled order (loggers ->
# manager -> proxies -> workers), ideally checking that one stage is up
# before launching the next. This is tricky because that's not the point
# of the Supervisor's response event. Until we have this, bootstrap
# might be noisy, particular in the Broker log.
for ( nodename in g_nodes )
{

View file

@ -44,7 +44,7 @@ export {
const topic = "zeek/management/controller" &redef;
## An optional custom output directory for stdout/stderr. Agent and
## controller currently only log locally, not via the data cluster's
## controller currently only log locally, not via the Zeek cluster's
## logger node. This means that if both write to the same log file,
## output gets garbled.
const directory = "" &redef;

View file

@ -81,11 +81,10 @@ global null_config: function(): Management::Configuration;
global is_null_config: function(config: Management::Configuration): bool;
# Checks whether the given instance is one that we know with different
# communication settings: a a different peering direction, a different listening
# communication settings: a different peering direction, a different listening
# port, etc. Used as a predicate to indicate when we need to drop the existing
# one from our internal state.
global is_instance_connectivity_change: function
(inst: Management::Instance): bool;
global is_instance_connectivity_change: function(inst: Management::Instance): bool;
# The set of agents the controller interacts with to manage to currently
# configured cluster. This may be a subset of all the agents known to the

View file

@ -81,7 +81,7 @@ export {
state: State;
## Role the node plays in cluster management.
mgmt_role: Role &default=NONE;
## Role the node plays in the data cluster.
## Role the node plays in the Zeek cluster.
cluster_role: Supervisor::ClusterRole &default=Supervisor::NONE;
## Process ID of the node. This is optional because the Supervisor may not have
## a PID when a node is still bootstrapping.