mirror of
https://github.com/zeek/zeek.git
synced 2025-10-15 13:08:20 +00:00
708b0df091
* topic/christian/management-deploy: (21 commits)
Management framework: bump external cluster testsuite
Management framework: bump zeek-client
Management framework: rename set_configuration events to stage_configuration
Management framework: trigger deployment upon when instances are ready
Management framework: more resilient node shutdown upon deployment
Management framework: re-trigger deployment upon controller launch
Management framework: move most deployment handling to internal function
Management framework: distinguish internally and externally requested deployments
Management framework: track instances by their Broker IDs
Management framework: tweak Supervisor event logging
Management framework: make helper function a local
Management framework: rename "log_level" to "level"
Management framework: add "finish" callback to requests
Management framework: add a helper for rendering result vectors to a string
Management framework: agents now skip re-deployment of current config
Management framework: suppress notify_agent_hello upon Supervisor peering
Management framework: introduce state machine for configs and persist them
Management framework: introduce deployment API in controller
Management framework: rename agent "set_configuration" to "deploy"
Management framework: consistency fixes to the Result record
...
(cherry picked from commit 54f2f28047)
111 lines
3.8 KiB
Text
111 lines
3.8 KiB
Text
##! Configuration settings for the cluster controller.
|
|
|
|
@load policy/frameworks/management
|
|
|
|
module Management::Controller;
|
|
|
|
export {
|
|
## The name of this controller. Defaults to the value of the
|
|
## ZEEK_CONTROLLER_NAME environment variable. When that is unset and the
|
|
## user doesn't redef the value, the implementation defaults to
|
|
## "controller-<hostname>".
|
|
const name = getenv("ZEEK_CONTROLLER_NAME") &redef;
|
|
|
|
## The controller's stdout log name. If the string is non-empty, Zeek
|
|
## will produce a free-form log (i.e., not one governed by Zeek's
|
|
## logging framework) in the controller's working directory. If left
|
|
## empty, no such log results.
|
|
##
|
|
## Note that the controller also establishes a "proper" Zeek log via the
|
|
## :zeek:see:`Management::Log` module.
|
|
const stdout_file = "stdout" &redef;
|
|
|
|
## The controller's stderr log name. Like :zeek:see:`Management::Controller::stdout_file`,
|
|
## but for the stderr stream.
|
|
const stderr_file = "stderr" &redef;
|
|
|
|
## The network address the controller listens on. By default this uses
|
|
## the value of the ZEEK_CONTROLLER_ADDR environment variable, but you
|
|
## may also redef to a specific value. When empty, the implementation
|
|
## falls back to :zeek:see:`Management::default_address`.
|
|
const listen_address = getenv("ZEEK_CONTROLLER_ADDR") &redef;
|
|
|
|
## The network port the controller listens on. Counterpart to
|
|
## :zeek:see:`Management::Controller::listen_address`, defaulting to the
|
|
## ZEEK_CONTROLLER_PORT environment variable.
|
|
const listen_port = getenv("ZEEK_CONTROLLER_PORT") &redef;
|
|
|
|
## The fallback listen port if :zeek:see:`Management::Controller::listen_port`
|
|
## remains empty.
|
|
const default_port = 2150/tcp &redef;
|
|
|
|
## Whether the controller should auto-assign listening ports to cluster
|
|
## nodes that need them and don't have them explicitly specified in
|
|
## cluster configurations.
|
|
const auto_assign_ports = T &redef;
|
|
|
|
## The TCP start port to use for auto-assigning cluster node listening
|
|
## ports, if :zeek:see:`Management::Controller::auto_assign_ports` is
|
|
## enabled (the default) and the provided configurations don't have
|
|
## ports assigned.
|
|
const auto_assign_start_port = 2200/tcp &redef;
|
|
|
|
## The controller's Broker topic. Clients send requests to this topic.
|
|
const topic = "zeek/management/controller" &redef;
|
|
|
|
## An optional custom output directory for stdout/stderr. Agent and
|
|
## 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 name of the Broker store the controller uses to persist internal
|
|
## state to disk.
|
|
const store_name = "controller";
|
|
|
|
## Returns the effective name of the controller.
|
|
global get_name: function(): string;
|
|
|
|
## Returns a :zeek:see:`Broker::NetworkInfo` record describing the controller.
|
|
global network_info: function(): Broker::NetworkInfo;
|
|
|
|
## Returns a :zeek:see:`Broker::EndpointInfo` record describing the controller.
|
|
global endpoint_info: function(): Broker::EndpointInfo;
|
|
}
|
|
|
|
function get_name(): string
|
|
{
|
|
if ( name != "" )
|
|
return name;
|
|
|
|
return fmt("controller-%s", gethostname());
|
|
}
|
|
|
|
function network_info(): Broker::NetworkInfo
|
|
{
|
|
local ni: Broker::NetworkInfo;
|
|
|
|
if ( Management::Controller::listen_address != "" )
|
|
ni$address = Management::Controller::listen_address;
|
|
else if ( Management::default_address != "" )
|
|
ni$address = Management::default_address;
|
|
else
|
|
ni$address = "0.0.0.0";
|
|
|
|
if ( Management::Controller::listen_port != "" )
|
|
ni$bound_port = to_port(Management::Controller::listen_port);
|
|
else
|
|
ni$bound_port = Management::Controller::default_port;
|
|
|
|
return ni;
|
|
}
|
|
|
|
function endpoint_info(): Broker::EndpointInfo
|
|
{
|
|
local epi: Broker::EndpointInfo;
|
|
|
|
epi$id = Management::Controller::get_name();
|
|
epi$network = network_info();
|
|
|
|
return epi;
|
|
}
|