Mirror/zeek
1
0
Fork 0
mirror of https://github.com/zeek/zeek.git synced 2025-10-02 06:38:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Management framework: rename set_configuration events to stage_configuration

Browse source 
This reflects corresponding renaming of the client's set-config command to
stage-config, to make it more clear what's happening.
This commit is contained in:
Christian Kreibich 2022-06-22 11:48:11 -07:00
parent 68558e2874
commit 2c1cd1d401
3 changed files with 31 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

35
scripts/policy/frameworks/management/controller/api.zeek
View file

@ -32,11 +32,11 @@ export {
result: Management::Result);
## The client sends this event to upload a new cluster configuration,
## including the full cluster topology. The controller validates the
## Upload a configuration to the controller for later deployment.
## The client sends this event to the controller, which validates the
## configuration and indicates the outcome in its response event. No
## deployment takes place yet, and existing deployed configurations and
## clusters remain intact. To trigger deployment of an uploaded
## the running Zeek cluster remain intact. To trigger deployment of an uploaded
## configuration, use :zeek:see:`Management::Controller::API::deploy_request`.
##
## reqid: a request identifier string, echoed in the response event.
@ -44,11 +44,11 @@ export {
## config: a :zeek:see:`Management::Configuration` record
## specifying the cluster configuration.
##
global set_configuration_request: event(reqid: string,
global stage_configuration_request: event(reqid: string,
config: Management::Configuration);
## Response to a set_configuration_request event. The controller sends
## this back to the client.
## Response to a stage_configuration_request event. The controller sends
## this back to the client, conveying validation results.
##
## reqid: the request identifier used in the request event.
##
@ -57,12 +57,12 @@ export {
## a single result record indicates so. Otherwise, the sequence is
## all errors, each indicating a configuration validation error.
##
global set_configuration_response: event(reqid: string,
global stage_configuration_response: event(reqid: string,
result: Management::ResultVec);
## The client sends this event to retrieve the currently deployed
## cluster configuration.
## The client sends this event to retrieve the controller's current
## cluster configuration(s).
##
## reqid: a request identifier string, echoed in the response event.
##
@ -85,13 +85,16 @@ export {
result: Management::Result);
## The client sends this event to trigger deployment of a previously
## uploaded configuration. The controller deploys the uploaded
## configuration to all agents involved in running the former
## configuration or the new one. The agents terminate any previously
## running cluster nodes and (re-)launch those defined in the new
## configuration. Once each agent has responded (or a timeout occurs),
## the controller sends a response event back to the client.
## Trigger deployment of a previously staged configuration. The client
## sends this event to the controller, which deploys the configuration
## to the agents. Agents then terminate any previously running cluster
## nodes and (re-)launch those defined in the new configuration. Once
## each agent has responded (or a timeout occurs), the controller sends
## a response event back to the client, aggregating the results from the
## agents. The controller keeps the staged configuration available for
## download, or re-deployment. In addition, the deployed configuration
## becomes available for download as well, with any augmentations
## (e.g. node ports filled in by auto-assignment) reflected.
##
## reqid: a request identifier string, echoed in the response event.
##