zeek/scripts/policy/frameworks/cluster/controller/api.zeek
Christian Kreibich 30db1b3bfb First uses of request state timeouts
This now features support for the test_timeout_request/response events, as
supported by the client, and also adds a timeout event for set_configuration, in
case agents do not respond in time.

Includes corresponding zeek-client submodule bump.
2021-12-21 14:52:29 -08:00

31 lines
1.1 KiB
Text

@load ./types
module ClusterController::API;
export {
const version = 1;
# Triggered when the operational instances align with desired ones, as
# defined by the latest cluster config sent by the client.
global notify_agents_ready: event(instances: set[string]);
global get_instances_request: event(reqid: string);
global get_instances_response: event(reqid: string,
result: ClusterController::Types::Result);
global set_configuration_request: event(reqid: string,
config: ClusterController::Types::Configuration);
global set_configuration_response: event(reqid: string,
result: ClusterController::Types::ResultVec);
# Testing events. These don't provide operational value but expose
# internal functionality, triggered by test cases.
# This event causes no further action (other than getting logged) if
# set_state is F. When T, the controller establishes request state. The
# conroller only ever sends the response event when this state times
# out.
global test_timeout_request: event(reqid: string, with_state: bool);
global test_timeout_response: event(reqid: string,
result: ClusterController::Types::Result);
}